This document provides a list of our platform’s outgoing email messages and the conditions that trigger each message. We list all obsolete templates that are not available anymore.
Note that you can disable any of these emails for an individual Tenant. The email configuration page explains how.
Template name: agent-request
- Soon to be deprecated.
This message is sent out in case a local agent is requested. By default, the email
is sent to support address or any address specified in the AGENT_REQUESTS_EMAIL
variable which is configurable in each tenant.
To trigger the message, follow these steps:
Name
and Description
for your agentOn the execution of step 4, an email will be sent to the specified address.
{
"html": "htmlstring",
"subject": "Agent request from {{{ORGANIZATION}}}",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Agent request from {{ORGANIZATION}}"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "USER",
"content": "TEST"
},
{
"name": "ORGANIZATION",
"content": "TEST"
},
{
"name": "AGENT_TITLE",
"content": "TEST"
},
{
"name": "AGENT_DESCRIPTION",
"content": "TEST"
},
{
"name": "AGENT_ID",
"content": "TEST"
}
]
}
Table below summarizes the variables:
Variable name | Example | Description |
---|---|---|
USER | Elvis Presley | user’s firstname and last name |
USER_EMAIL | bond@gmail.com | user email |
ORGANIZATION | Org | organization name |
ORGANIZATION_ID | 5ae5cc0121758047ebeb2547 | organization id |
AGENT_ID | 5ae5cc0121758047ebeb2547 | agent id |
AGENT_TITLE | TEST | agent title |
AGENT_DESCRIPTION | TEST | agent description |
Template name: contract-invite-empty-contract
This message is sent out to an existing platform user when they are added to a Contract as the first user.
To trigger the message, make API-call POST v2/contracts//invites
for a contract, which has no members yet. The invited user will receive a
corresponding email.
{
"html": "htmlTemplate",
"subject": "Invitation to join contract {{{CONTRACT}}} at {{{COMPANY}}}",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Invitation to join contract {{CONTRACT}} at {{COMPANY}}"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "CONTRACT",
"content": "TEST"
},
{
"name": "CODE",
"content": "code"
}
]
}
Variable na | Example | Description |
---|---|---|
CODE | 5ae5cc0121758047ebeb2547 | invite token id, used in link |
NAME | Elvis Presley | user’s firstname and last name |
CONTRACT | Contract | contract name |
CONTRACT_ID | 5ae5cc0121758047ebeb2547 | contract id |
ROOT_PATH | /c/5ae5cc0121758047ebeb2547 | frontend path for contract |
CONTRACT_INVITE_PATH | /contract/invite/5ae5cc0121758047ebeb2547 | invite path used in link https:// |
Template name: contract-invite-new-user
This message is sent out to a user when they are invited to a Contract.
To trigger the message, follow these steps:
On the execution of step 4, The invited user will receive a corresponding email.
{
"html": "htmlTemplate",
"subject": "Invitation to join contract {{{CONTRACT}}} at {{{COMPANY}}}",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Invitation to join contract {{CONTRACT}} at {{COMPANY}}"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "CONTRACT",
"content": "TEST"
},
{
"name": "CODE",
"content": "code"
}
]
}
Variable na | Example | Description |
---|---|---|
CODE | 5ae5cc0121758047ebeb2547 | invite token id, used in link |
NAME | Elvis Presley | user’s firstname and last name |
CONTRACT | Contract | contract name |
CONTRACT_ID | 5ae5cc0121758047ebeb2547 | contract id |
ROOT_PATH | /c/5ae5cc0121758047ebeb2547 | frontend path for contract |
CONTRACT_INVITE_PATH | /contract/invite/5ae5cc0121758047ebeb2547 | invite path used in link https:// |
Template name: workspace-invite-new-user
This message is sent out to an existing platform user when they are added to a Workspace.
To trigger the message, follow these steps:
On the execution of step 4, an email will be sent to the added user.
{
"html": "htmlTemplate",
"subject": "Invitation to join workspace {{{WORKSPACE}}} at {{{COMPANY}}}",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Invitation to join workspace {{WORKSPACE}} at {{COMPANY}}"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "WORKSPACE",
"content": "TEST"
},
{
"name": "CODE",
"content": "code"
},
{
"name": "CONTRACT_ID",
"content": "CONTRACT_ID"
},
{
"name": "WORKSPACE_ID",
"content": "WORKSPACE_ID"
}
]
}
Template name: password-recovery
This message is sent out to a user when they request password recovery.
To trigger the message, follow these steps:
On the execution of step 4, the user will receive an email with reset password link.
{
"tenantId": "mongo-object-id",
"locale": "en",
"name": "password-recovery",
"message": {
"from_name": "{{{COMPANY}}} team",
"track_opens": true,
"track_clicks": false,
"auto_text": true,
"url_strip_qs": false,
"preserve_recipients": true,
"merge_language": "handlebars",
"html": "Some new custom html string (with css)",
"subject": "{{{COMPANY}}} password recovery",
"global_merge_vars": [
{
"name": "CURRENT_YEAR",
"content": "2018"
},
{
"name": "APP_DOMAIN",
"content": "app.elastic.io"
},
{
"name": "SUBJECT",
"content": "{{COMPANY}} password recovery"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "LIST_ADDRESS_HTML",
"content": "list_address_html"
},
{
"name": "CODE",
"content": "12345"
},
{
"name": "FNAME",
"content": "TEST"
}
]
}
}
Variable name | Example | Description |
---|---|---|
FNAME | Elvis Presley | user’s firstname |
CODE | https:///reset?code= | token id |
Template name: team-from-contract-invite
This message is sent out to a Developer when they are invited to a Developer Team.
To trigger the message, follow these steps:
On the execution of step 5, the selected user will receive an invitation email.
{
"html": "htmlTemplate",
"subject": "Invitation to join team {{{TEAM}}} at {{{COMPANY}}}",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Invitation to join team {{TEAM}} at {{COMPANY}}"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "TEAM",
"content": "TEST"
},
{
"name": "TEAM_ID",
"content": "TEAM_ID"
},
{
"name": "ROOT_PATH",
"content": "/"
},
{
"name": "CONTRACT_ID",
"content": "CONTRACT_ID"
},
{
"name": "CONTRACT_NAME",
"content": "Name of the contract"
}
]
}
Variable name | Example | Description |
---|---|---|
NAME | Elvis Presley | user’s firstname and last name |
TEAM | dev | team name |
CONTRACT_NAME | Horns & Roofs | contract name |
TEAM_PATH | /c/5b4f3371ff4304610483b909/#/account/contract/5b4f3371ff4304610483b909/teams/557aee0d5925ab0900000001 | team path, used in link https:// |
Template name: task-error-notification
This message is sent out to a user that subscribed to Flow errors, when a component in the Flow reports an error.
To trigger the message, follow these steps:
On the execution of step 6, you will receive the corresponding email.
NOTE: The email will be sent once per hour in case of a repeating error, no matter how often the error happens. This interval cannot be configured.
{
"html": "htmlTemplate",
"subject": "Your task \"{{{TASK_NAME}}}\" failed with error",
"from_name": "{{COMPANY}} error bot",
"inline_css": true,
"global_merge_vars": [
{
"name": "MESSAGE",
"content": "error message"
},
{
"name": "ORIGINAL_MESSAGE",
"content": "error message"
},
{
"name": "LAST_SEEN",
"content": "last seen"
},
{
"name": "COMPANY",
"content": "elastic.io"
},
{
"name": "TASK_NAME",
"content": "Unknown task"
},
{
"name": "TASK_ID",
"content": "Unknown step"
},
{
"name": "STEP_ID",
"content": "Unknown step"
},
{
"name": "COMP_ID",
"content": "Unknown comp"
},
{
"name": "COMP_NAME",
"content": "Unknown comp name"
},
{
"name": "METHOD",
"content": "Unknown method"
},
{
"name": "EXECUTION_PATH",
"content": ""
}
]
}
Variable name | Example | Description |
---|---|---|
ORIGINAL_MESSAGE | n/a | error message |
STACK | n/a | error stack |
TASK_ID | 5ae5cc0121758047ebeb2547 | task id |
STEP_ID | step_1 | step id |
EXEC_ID | 63d0a7cdc8a34fa5b6b7d4ab37773572 | execution id |
COMP_ID | 5ae5cc0121758047ebeb2547 | component id |
METHOD | unknown method | component method |
TASK_NAME | task | task name |
COMP_NAME | comp | component name |
EXECUTION_PATH | https:// | path to execution |
Template name: task-operational-error
This message is sent out to a user that subscribed to Flow errors, when a container execution fails in K8S.
To trigger the message, follow these steps:
On the execution of step 5, you will receive the corresponding email.
NOTE: The email will be sent once per 24h in case of a repeating error, no matter how often the error happens. This interval cannot be configured.
{
"subject": "Your flow \"{{{TASK_NAME}}}\" failed with unexpected error",
"html": "htmlTemplate",
"global_merge_vars": [
{
"name": "MESSAGE",
"content": "error message"
},
{
"name": "LAST_SEEN",
"content": "last seen"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
}
]
}
Variable name | Example | Description |
---|---|---|
ORIGINAL_MESSAGE | n/a | error message |
STACK | n/a | error stack |
TASK_ID | 5ae5cc0121758047ebeb2547 | task id |
STEP_ID | step_1 | step id |
EXEC_ID | 63d0a7cdc8a34fa5b6b7d4ab37773572 | execution id |
COMP_ID | 5ae5cc0121758047ebeb2547 | component id |
METHOD | unknown method | component method |
TASK_NAME | task | task name |
COMP_NAME | comp | component name |
EXECUTION_PATH | https:// | path to execution |
Template name: wiper-flow-suspended-due-to-queue-overflow
This message is sent out to the Flow author when his Flow gets suspended due to
RabbitMQ
queue overflow. The overflow is triggered when the total count of
messages or total size of a queue exceeds the 80% threshold. This percentage value
is non-changeable. However, your Platform Operations Team can configure the absolute
maximum values of messages per queue or size in MB per queue with the following
environment variables per installation:
RABBITMQ_MAX_MESSAGES_PER_QUEUE
for message limitRABBITMQ_MAX_MESSAGES_MBYTES_PER_QUEUE
for size limitTo trigger the message, follow these steps:
* * * * *
Realtime
On the execution of step 7, the Flow author will receive the corresponding email.
{
"html": "htmlTemplate",
"subject": "Flow {{{FLOW_ID}}} {{{FLOW_NAME}}} has been suspended due to queue overflow",
"from_name": "{{{COMPANY}}} error bot",
"inline_css": true,
"global_merge_vars": [
{ "name": "COMPANY", "content": "n/a" },
{ "name": "CONTRACT_NAME", "content": "n/a" },
{ "name": "WORKSPACE", "content": "n/a" },
{ "name": "SUSPENDED_CLEANUP_PERIOD_DAYS", "content": "n/a" },
{ "name": "FLOW_ID", "content": "n/a" },
{ "name": "FLOW_NAME", "content": "n/a" },
{ "name": "FLOW_PATH", "content": "n/a" },
{ "name": "MESSAGES", "content": "n/a" },
{ "name": "MESSAGES_LIMIT", "content": "n/a" },
{ "name": "BYTES", "content": "n/a" },
{ "name": "BYTES_LIMIT", "content": "n/a" }
]
}
Template name: team-removed-member
This email is sent to a user whose membership in a Developer Team has been terminated.
To trigger the message, follow these steps:
DELETE https://api.elastic.io/v2/teams/{TEAM_ID}/relationships/members
{
"data": {
"type": "user",
"id": "{user_id}"
}
}
request to remove a member
{
"html": "htmlTemplate",
"subject": "Developer Team Membership Update",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Developer Team Membership Update"
},
{
"name": "COMPANY",
"content": "ACME"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "TEAM",
"content": "TEST"
},
{
"name": "ROOT_PATH",
"content": "/"
},
{
"name": "CONTRACT_NAME",
"content": "Name of the contract"
}
]
}
Variable name | Example | Description |
---|---|---|
NAME | Elvis Presley | User’s first name and last name |
TEAM | A-TEAM | Team name |
CONTRACT_NAME | ACME | Contract name |
Template name: repo-new-version
This email is sent to all members of the Developer Team where the new version was pushed.
To trigger the message, follow these steps:
{
"html": "htmlTemplate",
"subject": "Component version changes",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Component version changes"
},
{
"name": "COMPANY",
"content": "ACME"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "TEAM",
"content": "TEST"
},
{
"name": "COMPONENT_NAME",
"content": "TEST"
},
{
"name": "TEAM_ID",
"content": "TEAM_ID"
},
{
"name": "REPO_ID",
"content": "REPO_ID"
},
{
"name": "CONTRACT_ID",
"content": "CONTRACT_ID"
},
{
"name": "REPO_PATH",
"value": "/c/CONTRACT_ID/#/contract/CONTRACT_ID/teams/TEAM_ID/REPO_ID"
},
{
"name": "ROOT_PATH",
"content": "/"
},
{
"name": "CONTRACT_NAME",
"content": "Name of the contract"
}
]
}
Variable name | Example | Description |
---|---|---|
NAME | Elvis Presley | User’s first name and last name |
TEAM | A-TEAM | Team name |
COMPONENT_NAME | Component name | |
CONTRACT_NAME | ACME | Contract name |
CONTRACT_ID | 5b4f3371ff4304610483b909 | Contract ID |
REPO_ID | 5ae5cc0121758047ebeb2547 | Repository ID |
TEAM_ID | 557aee0d5925ab0900000001 | Team ID |
REPO_PATH | /c/5b4f3371ff4304610483b909/#/account/contract/5b4f3371ff4304610483b909/teams/557aee0d5925ab0900000001/repo/5ae5cc0121758047ebeb2547 | path, used in link https:// |
Template name: repo-new-version-in-workspace-flows
This email is sent to all Platform users who use the mentioned Component in their Flows.
To trigger the message, follow these steps:
{
"html": "htmlTemplate",
"subject": "Component version changes",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Component version changes"
},
{
"name": "COMPANY",
"content": "ACME"
},
{
"name": "NAME",
"content": "TEST"
},
{
"name": "TEAM",
"content": "TEST"
},
{
"name": "COMPONENT_NAME",
"content": "TEST"
},
{
"name": "TEAM_ID",
"content": "TEAM_ID"
},
{
"name": "REPO_ID",
"content": "REPO_ID"
},
{
"name": "CONTRACT_ID",
"content": "CONTRACT_ID"
},
{
"name": "REPO_PATH",
"value": "/c/CONTRACT_ID/#/contract/CONTRACT_ID/teams/TEAM_ID/REPO_ID"
},
{
"name": "ROOT_PATH",
"content": "/"
},
{
"name": "CONTRACT_NAME",
"content": "Name of the contract"
}
]
}
Variable name | Example | Description |
---|---|---|
NAME | Elvis Presley | User’s first name and last name |
TEAM | A-TEAM | Team name |
COMPONENT_NAME | Component name | |
CONTRACT_NAME | ACME | Contract name |
CONTRACT_ID | 5b4f3371ff4304610483b909 | Contract ID |
REPO_ID | 5ae5cc0121758047ebeb2547 | Repository ID |
TEAM_ID | 557aee0d5925ab0900000001 | Team ID |
Template name: workspace-removed
This email is sent to all Workspace members.
To trigger the message, follow these steps:
{
"html": "htmlTemplate",
"subject": "Workspace Update",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Workspace Update"
}
]
}
Variable name | Example | Description |
---|---|---|
USER_NAME | Elvis Presley | User’s first name and last name |
CONTRACT_NAME | ACME | Contract name |
CONTRACT_ID | 5b4f3371ff4304610483b909 | Contract ID |
WORKSPACE_NAME | ACME Production | Workspace name |
WORKSPACE_ID | 557aee0d5925ab0900000001 | Workspace ID |
CONTRACT_PATH | /c/5b4f3371ff4304610483b909 | Contract path to be used in the address |
Template name: workspace-removed-member
This email is sent to a user whose membership in a Workspace has been terminated.
DELETE https://api.elastic.io/v2/workspaces/{WORKSPACE_ID} \
API request
3.{
"html": "htmlTemplate",
"subject": "Workspace Membership Update",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Workspace Membership Update"
}
]
}
Variable name | Example | Description |
---|---|---|
USER_NAME | Elvis Presley | User’s first name and last name |
CONTRACT_NAME | ACME | Contract name |
CONTRACT_ID | 5b4f3371ff4304610483b909 | Contract ID |
WORKSPACE_NAME | ACME Production | Workspace name |
WORKSPACE_ID | 557aee0d5925ab0900000001 | Workspace ID |
CONTRACT_PATH | /c/5b4f3371ff4304610483b909 | Contract path to be used in the address |
Template name: wiper-contract-suspended
This email is sent to all members of the suspended Contract.
POST https://api.elastic.io/v2/contracts/CONTRACT_ID/suspend/
API call{
"html": "htmlTemplate",
"subject": "Contract suspended",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Contract suspended"
},
{
"name": "COMPANY",
"content": "ACME"
},
{
"name": "USER_NAME",
"content": "First Last"
},
{
"name": "CONTRACT_NAME",
"content": "Contract Name"
}
]
}
Variable name | Example | Description |
---|---|---|
USER_NAME | Elvis Presley | User’s first name and last name |
CONTRACT_NAME | ACME | Contract name |
Template name: contract-unsuspended
This email is sent to all members of the unsuspended Contract.
POST https://api.elastic.io/v2/contracts/CONTRACT_ID/suspend/
API callPOST https://api.elastic.io/v2/contracts/CONTRACT_ID/unsuspend/
API call{
"html": "htmlTemplate",
"subject": "Contract unsuspended",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Contract unsuspended"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "USER_NAME",
"content": "FirstName LastName"
},
{
"name": "CONTRACT_NAME",
"content": "Contract Name"
}
]
}
Variable name | Example | Description |
---|---|---|
USER_NAME | Elvis Presley | User’s first name and last name |
CONTRACT_NAME | ACME | Contract name |
Template name: wiper-contract-deleted
This email is sent to all members of the removed Contract.
DELETE https://api.elastic.io/v2/contracts/{CONTRACT_ID} \
API call{
"html": "htmlTemplate",
"subject": "Contract Removed",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Contract Removed"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "USER_NAME",
"content": "First Last"
},
{
"name": "CONTRACT_NAME",
"content": "Contract Name"
}
]
}
Variable name | Example | Description |
---|---|---|
USER_NAME | Elvis Presley | User’s first name and last name |
CONTRACT_NAME | ACME | Contract name |
Template name: user-removed-from-contract
This email is sent to a user whose membership in a Contract has been terminated.
DELETE https://api.elastic.io/v2/contracts/{CONTRACT_ID}/members/{USER_ID}/
API request{
"html": "htmlTemplate",
"subject": "Contract Membership Update",
"global_merge_vars": [
{
"name": "SUBJECT",
"content": "Contract Membership Update"
},
{
"name": "COMPANY",
"content": "elastic.io GmbH"
},
{
"name": "USER_NAME",
"content": "FirstName LastName"
},
{
"name": "CONTRACT_NAME",
"content": "Contract Name"
}
]
}
Variable name | Example | Description |
---|---|---|
USER_NAME | Elvis Presley | User’s first name and last name |
These templates are all unusable now, and may have never been used at all. The list is for reference purposes only, none of these templates are in use now.
Template Name | Description |
---|---|
organization-invite-new-user |
Sent to a user that has been invited to an Organization (an obsolete enclosed environment before Contracts and Workspaces) |
organization-invite-empty-org |
Sent to a user that has been invited to an empty Organization |
wiper-suspended-flow-stopped |
In case messages in a suspended flow queue exceeded RabbitMQ limit, the flow got stopped and this template was sent to the creator |
wiper-suspended-queue-purged |
In case messages in a suspended flow queue exceeded a certain limit, the queue got purged, and this template was sent |
workspace-invite-empty-workspace |
Erroneous, never been used |
team-invite-existing-user |
Erroneous |
wiper-flow-suspended |
Sent to a user whose Flow has been suspended |