Push Events

04 Mar 2025
37 Minutes to read

Print
Share
Dark
Light

Push Events

Updated on 04 Mar 2025
37 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Event Payload

All webhook events are sent in JSON format with a standard envelope containing the event name, event timestamp, unique event id and payload. The payload will contain additional properties based on the event that was emitted. Please see the individual webhook event documentation for complete details on each event’s specific payload properties.

When parsing the event payload, Relay strongly recommends following the Tolerant Reader Pattern ( http://servicedesignpatterns.com/WebServiceEvolution/TolerantReader). In summary, this pattern says - Parse only the fields you are interested in and ignore everything else including strict validation. Relay, in the future, may add additional properties to and existing event and following the Tolerant Reader Pattern will ensure your existing integration does not break.

Connection Events

Event	Event Description	Event Use
account.deactivate	The end user account has been deactivated.	Optional. Use if deactivation processes are utilized and an flag to indicate a deactivated account is helpful in downstream processing. A deactivation process will trigger notification_channel.remove events for all phone numbers connected to the account and then an account.deactive event.
channel_consent.update	Consent has changed for the channel.	Use to keep a Client consent store in sync with Relay’s consent store. When Relay reports a consent change, the same change is made to the Client consent store.
notification_channel.add	A notification channel has been added to the customer account.	Use to keep a Client connection DB in sync with Relay’s connection DB. When Relay reports a notification channel add, it indicates a new phone number has been joined to the CCID. The act of adding a phone number to an account requires consent. If the consent of the phone number being added is new or changes from what is stored in Relay, a channel_consent.update event will also emit. This may be paired with a notification_channel.remove event when updating the phone number of an account
notification_channel.remove	A notification channel has been removed from the customer account	Used to keep a Client connection DB in sync with Relay’s connection DB. When Relay reports a notification channel remove, it indicates a phone number has been removed from the CCID. The act of removing a phone number from an account DOES NOT update the consent associated to the phone number. This may be paired with a notification_channel.add event when updating the phone number of an account.

Experience Events

Event	Event Description	Event Use
message.delivered	The message was posted to the Customer’s feed.	Used to track the successful posting of a message to a Customer’s feed.
message.undelivered	The message failed to post to the Customer’s feed.	Used to identify bad connections, missing input parameters, and duplicates. When Relay reports a message undelivered event, it also reports a reason.
notification.attempted	The SMS notification was attempted.	Used to track the successful send of an SMS from Relay to our SMS aggregator.
notification.not_attempted	The SMS notification was not attempted.	Used to identify accounts without consent, missing input parameters and duplicates. When Relay reports a notification not attempted event, it also reports a reason.
notification.delivered	The SMS was delivered to the Customer’s mobile device.	Used to track the successful delivery of an SMS notification to a Customer’s device. This event is provided by our SMS aggregator and may take up to 72 hours after notification attempted for this event to be received by Relay.
notification.undelivered	The SMS failed delivery to the Customer’s mobile device.	Used to track the unsuccessful delivery of an SMS notification to a Customer’s device. This event is provided by our SMS aggregator and may take up to 72 hours after notification attempted for this event to be received by Relay.
notification.auth_link_used	The Customer clicked on the auth link in their notification.	Used to track the clicking of an auth link in a notification by the Customer. By clicking an auth link, the Customer is taken to a message on their feed. From there, the Customer could interact with any message on the feed, not just the message associated directly to the auth link clicked.
message.action_taken	The Customer took an action on their feed.	Used to track the actions taken in the feed by a Customer

Two Way Events

Event	Event Description	Event Use
twoway.agent_ping	An agent pings a customer.	Used to track the ping in the relay messenger by an agent.
twoway.channel_closed	An agent closes a conversation.	Used to track the channel closed in the relay messenger by an agent.
twoway_webhook.agent_message_sent	An agent sends a message to the customer via relay messenger.	Used to track a message sent by an agent.
twoway_webhook.customer_message_sent	A customer sends a message to an agent via relay messenger.	Used to track a message sent by the customer.
twoway_webhook.system_message_sent	A configured auto-response message was sent to the customer.	Used to track a message triggered by the auto-response system.

Event: channel_consent.update

This event is emitted any time the user’s consent is changed.

webhook event channel consent update flow

Example Event Object

{
    "event_id": "ip-10-1-4-153-2096492-az-b1849c0f-1584-48bf-8201-deda9fa6670e-1oz9",
    "event_ts": "2022-03-28T22:00:09.614Z",
    "payload": {
        "product_group_id": "default",
        "source_channel": "csr",
        "channel_addr": "11058559276",
        "channel_type": "sms",
        "ccid": "opt-me-out",
        "relay_tracking_id": "a642b9a0-af0d-449f-9069-57a853b5c734",
        "previous_consent_type": "written",
        "client_id": "relay_network",
        "consent_type": "stop"
    },
    "event_name": "channel_consent.update"
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
source_channel	string	Identifies the source where the event originated from. Example values are: add-phone.api api csr file ivr legacy-onboarding.api onboarding-api onboarding.file phone-management-add.file sign-up-page sms_conversation stop-conversation wire.message
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
ccid	string	The unique identifier of the Customer.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
previous_consent_type	string	Identifies the previous consent for the Customer.
client_id	string	The unique identifier of the Client.
consent_type	string	Specifies the type of consent assigned to Customer's or Patient's phone number. Valid values are: written The phone number will have express written consent. express The phone number will have express consent. stop The phone number will have stop consent.
event_name	string	Name of the webhook event.

Event: account.deactivate

This event is emitted when a user (Customer) is deactivated from the Relay platform. Once a user is deactivated, they will no longer be able to receive notifications or access their Feed.

webhook event account deactivate flow

Example Event Object

{
    "event_id": "ip-10-2-4-110-1633159-q2t-77656a49-5061-42ed-8ef6-f0ece8705a83-208w",
    "event_ts": "2022-04-12T01:13:43.126Z",
    "payload": {
        "product_group_id": "default",
        "ccid": "deactive-my-ccid",
        "relay_tracking_id": "5f1d883f-3e7c-4d93-9cb8-d59359b81e81",
        "client_id": "relay_network",
        "job_id": null,
        "customer_id": "7341e921-ba16-46f2-a330-476ae7d36f9a",
        "source_channel": "deactivate-api",
        "notification_channels": [
            {
                "channel_addr": "11058559276",
                "channel_type": "sms"
            },
            {
                "channel_addr": "11904477901",
                "channel_type": "sms"
            }
        ]
    },
    "event_name": "account.deactivate"
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
ccid	string	The unique identifier of the Customer.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
client_id	string	The unique identifier of the Client.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
customer_id	UUID	The internal, Relay assigned, customer identifier.
source_channel	string	Identifies the source where the event originated from. Example values are: add-phone.api api csr file ivr legacy-onboarding.api onboarding-api onboarding.file phone-management-add.file sign-up-page sms_conversation stop-conversation wire.message
notification_channels	string	This collections contains zero or more notification channels. Each notification channel is defined by a combination of channel_type and channel_addr.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
event_name	string	Name of the webhook event.

Event: message.action_taken

This event is emitted when a user takes an action on the Feed. The action_types property of the event structure identifies the specific type of action that occurred.

Summary of action_type values:

call

The user click the call phone number action button.

collapsible

The user expanded a collapsible section.

The user clicked on an email action button.

hyperlink

The user clicked on a hyperlink navigation button.

message_branch

The user clicked on a message branch.

twoway

The user clicked on two way action button.

consent_upgrade

The user clicked on consent upgrade button.

email_data_capture

The user captured the email data.

form_info_capture

The user captured the form info.

Example Event Object

{
    "event_id": "568C69C9-702D-478B-BC00-923C3F9F3BDD",
    "event_name": "message.action_taken",
    "event_ts": "2018-01-01T12:00:00.000Z",
    "payload": {
        "action_type": "call",
        "action_label": "Call customer service",
        "action_value": "(800) 555-1212",
        "ccid": "1000-aa-13CE",
        "client_id": "onelifehealth",
        "client_message_tag": "call-support",
        "channel_addr": "10005551212",
        "channel_type": "sms",
        "customer_id": "9006E214-5261-4736-9192-B0ADD3005723",
        "job_id": "A689672A-0A6E-4E99-8C5D-1CAD3728CA32",
        "journey_id": "44BE6B5D-26B1-40EA-9750-2E8C82067AF6",
        "message_id": "3AE05D87-B00E-42E7-9D68-C16C73B68162",
        "message_name": "nickname",
        "notification_id": "8BD6EBD9-94F4-4746-82DA-542E98D86823",
        "product_group_id": "default",
        "relay_tracking_id": "99999999-8888-7777-6666-555555555555",
        "trigger_id": "F9564106-C25A-4FD2-A9DF-F26ADC1D1362"
    }
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
action_type	string	Indicate what kind of action was taken by the user. See below for additional documentation on each specific action_type.
action_label	string	The action label describing the action of the feed user. Also referred to as the text on an action element within a feed experience. Examples: "Call Customer Service" or "Provide Feedback"
action_value	string	The destination of an action paired with the Action Label. Example: Action Label: Call Customer Service Action Value: (800) 555 1234
ccid	string	The unique identifier of the Customer.
client_id	string	The unique identifier of the Client.
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
customer_id	UUID	The internal, Relay assigned, customer identifier.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
journey_id	string	The unique Journey identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
message_name	string	The name of the message that was set in the CXB.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.

Action Type Properties

There are several different action events that can take place in the Feed. The event payload data depends on the type of action an event represents.

action_type	action_label	action_value	Description
call	The text of the label describing the phone number to be called	The phone number that was attempted to be called	The user clicked on a call action button. This action will open the device’s default phone application with the phone number pre-populated. However, this does not mean the user actually placed the call because the user can cancel the phone action which is not reported back to the Relay application.
collapsible	The text of the label identifying the collapsible section that was expanded	n/a	The user expanded a collapsible section.
email	The label describing the target email address.	The destination email address (e.g. the to: field).	The user clicked on an email action. This action will open the device’s default email application with the to: field prepopulated. However, this action does not imply that an actual email was sent as the user could have canceled the send action from the email application.
hyperlink	The text of the label describing the hyperlink.	The value of the hyperlink.	The user clicked on a hyperlink action button.
message_branch	The text of the label describing the messsage branch.	The message id of the branch that was taken.	The user clicked on a message branch. A message branch is a sub message in the feed.
chat	This label describing the two-way chat action.	This value will be the same as action_label.	The user clicked the Relay two-wat chat button. This opens the Relay two-way chat system.
twoway	The text of the label describing the two-way.	The value of the two-way.	The user clicked on two way action button.
consent_upgrade	The text of the label describing the consent upgrade.	The value of the consent upgrade.	The user clicked on consent upgrade button.
email_data_capture	The text of the label describing the email data capture.	The value of email data that was captured.	The user captured the email data.
form_info_capture	The text of the label describing the form info capture.	The value of form information that was captured.	The user captured the form info.

Event: message.delivered

This event is emitted when the system successfully posted a message to the Customer’s feed.

Example Event Object

{
  "event_id": "68EB7899-28D1-4546-9F97-F6E76EE9C184",
  "event_name": "message.delivered",
  "event_ts": "2018-10-16T13:08:00.745Z",
  "payload": {
    "ccid":                       "1001",
    "client_id":                  "onelifehealth",
    "client_trigger_id":          "welcome",
    "client_message_tag":         "",
    "customer_id":                "0000-0000-0000-0000",
    "job_id":                     "3432c918-2b99-41b0-a7ab-36b312f3620b",
    "journey_id":                 "97s34a57-2816-489a-b78c-a4310abf232b",
    "message_id":                 "1ffdca03-714e-4280-8681-3d3a33f38043",
    "message_name":               "Welcome",
    "notification_id":            ""
    "product_group_id":           "default",
    "relay_tracking_id":          "06ac1498-ff5e-4831-b686-62177ed249a5"
    "trigger_id":                 "8945B43E-A68E-434C-B5F1-FAC1A5731B0C",
  },
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
ccid	string	The unique identifier of the Customer.
client_id	string	The unique identifier of the Client.
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
journey_id	string	The unique Journey identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
message_name	string	The name of the message that was set in the CXB.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.

Event: message.undelivered

This event is emitted when the system was unable to add the message to the Customer’s feed. Review the error_type and error_string for the undelivered reason.

Example Event Object

{
  "event_id": "68EB7899-28D1-4546-9F97-F6E76EE9C184",
  "event_name": "message.undelivered",
  "event_ts": "2018-10-16T13:08:00.745Z",
  "payload": {
    "ccid":                     "9999",
    "client_id":                "onelifehealth",
    "client_trigger_id":        "v3_j_11",
    "client_message_tag":       "client-provided-identifier",
    "customer_id":              "0000-0000-0000-0000",
    "job_id":                   "3432c918-2b99-41b0-a7ab-36b312f3620b",
    "journey_id":               "97s34a57-2816-489a-b78c-a4310abf232b",
    "message_id":               "1ffdca03-714e-4280-8681-3d3a33f38043",
    "message_name":             "Welcome",
    "notification_id":          "8BD6EBD9-94F4-4746-82DA-542E98D86823",
    "product_group_id":         "default",
    "relay_tracking_id":        "06ac1498-ff5e-4831-b686-62177ed249a5",
    "trigger_id":               "8945B43E-A68E-434C-B5F1-FAC1A5731B0C",
    "error_type":               "trigger-not-found",
    "error_string":             "No journey found for trigger_id None.",
  }
}

Event Properties

Property

Data Type

Description

event_id

UUID

This is a unique Relay identifier used for tracking.

event_name

string

Name of the webhook event.

event_ts

timestamp

Contains the date and time of when the event occurred. The data is in ISO 8601 format.

payload

Contains additional properties that are specific to the event.

ccid

string

The unique identifier of the Customer.

client_id

string

The unique identifier of the Client.

client_trigger_id

string

An optional, Client provided, trigger id value.

client_message_tag

string

An optional, Client created, tag that was provided during the initial messaging/onboarding request.

customer_id

string

The internal, Relay assigned, customer identifier.

job_id

string

Internal unique job identifier of the originating event. This field is optional and may not always be set.

journey_id

string

The unique Journey identifier that was the originating source of the event.

message_id

string

The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.

message_name

string

The name of the message that was set in the CXB.

notification_id

string

The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.

product_group_id

string

The current product group identifier of the Customer. An account is associated to one and only one product group at a time.

relay_tracking_id

string

An internal Relay identifier for the event. This value is optional and may be set to null.

trigger_id

string

The unique Trigger identifier that was the originating source of the event.

error_type

string

Identifies the type of error that occurred. Valid values are:

Error	Description
ccid-not-found	The CCID specified was not found.
missing-fields	The same message was already sent within the duplicate suppression window.
invalid-html-in-wire-message	The experience may hav an invalid HTML tag in the message or SMS body.
invalid-html-in-sms-message	The experience may hav an invalid HTML tag in the message or SMS body.
throttle-customer	Message exceeds SMS send window threshold.
duplicate-request	The same message was already sent within the duplicate suppression window.
trigger-not-found	The trigger_id could not be found for the corresponding client_id.
journey-archived	The experience has been archived.
customer-deactivated	The customer specified has been deactivated.

error_string

string

The human readable message for each error type in the “Description” column.

Event: notification.attempted

This event is emitted when Relay sends an SMS message to the aggregator and the aggregator responded successfully that the request has been received and is sending to the carrier for final delivery to the Customer’s mobile device.

Example Event Object

{
  "event_id": "320A93CE-F356-4379-B14B-EE01C31FB2C9",
  "event_name": "notification.attempted",
  "event_ts": "2018-10-16T13:08:00.745Z",
  "payload": {
    "ccid":                       "1001",
    "channel_addr":               "11005551212",
    "channel_type":               "sms",
    "client_id":                  "onelifehealth",
    "client_message_tag":         "",
    "client_trigger_id":          "26534380-FE62-46C8-8FA2-10143A6FC165",
    "customer_id":                "9E3D8ADC-E70E-4351-B559-4805CFA4FB35",
    "event_type":                 "notification",
    "event_subtype":              "attempted",
    "product_group_id":           "default",
    "job_id":                     "EA637AD1-CCC3-4EF6-A3F0-CC5E25667181",
    "journey_id":                 "EB78F251-F773-4B03-9868-8C5F7B0C200E",
    "message_id":                 "A32DC255-24A0-4388-BBF8-42AAF42C7D12",
    "notification_id":            "516ED2CD-CA4E-4A0D-B5F7-44DE600F854C",
    "relay_tracking_id":          "EE9E5353-10CB-492B-8A8F-BA85AA675E87"
    "trigger_id":                 "392C875C-9EC0-49E3-B39A-A37434E78493",
    "sms_text":                   "Welcome to One Life Health\n @{auth-link} Text help or stop. Msg&DataRatesMayApply",
    "launched_by": {
        "lb-name": "system-initiated",
        "lb-source": "system-initiated"
    }
  }
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
ccid	string	The unique identifier of the Customer.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
client_trigger_id	string	An optional, Client provided, trigger id value.
customer_id	string	The internal, Relay assigned, customer identifier.
event_subtype	string	Identifies the subtype of the event.
event_type	string	Identifies the main event type category.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
journey_id	string	The unique Journey identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
sms_text	string	The actual text of the SMS message that was sent.
launched_by	object	An optional object that contains details on the source of the notification.
lb-name	string	Launched by name. If set, identifies the name of the user that triggered the notification.
lb-source	string	Launched by source. If set, identifies the source system that triggered the notification.

Event: notification.not_attempted

This event is emitted for SMS messages that are not sent. Reasons for an SMS not being sent include:

Sent during blackout hours.
Sent to a customer with no notification channels.
Sent to a notification channel with no consent.
Sent when 10 messages have already been sent to the customer in a 15 minute window.
Sent to a deactivated customer.
An identical message has already been sent within a 15 minute window.

Example Event Object

{
  "event_id": "320A93CE-F356-4379-B14B-EE01C31FB2C9",
  "event_name": "notification.not_attempted",
  "event_ts": "2018-10-16T13:08:00.745Z",
  "payload": {
    "ccid":                       "1001",
    "channel_addr":               "11005551212",
    "channel_type":               "sms",
    "client_id":                  "onelifehealth",
    "client_message_tag":         "",
    "customer_id":                "9E3D8ADC-E70E-4351-B559-4805CFA4FB35",
    "event_subtype":              "not_attempted",
    "event_type":                 "notification",
    "product_group_id":           "default",
    "job_id":                     "EA637AD1-CCC3-4EF6-A3F0-CC5E25667181",
    "journey_id":                 "EB78F251-F773-4B03-9868-8C5F7B0C200E",
    "message_id":                 "A32DC255-24A0-4388-BBF8-42AAF42C7D12",
    "message_name":               "The message name",
    "notification_id":            "516ED2CD-CA4E-4A0D-B5F7-44DE600F854C",
    "relay_tracking_id":          "EE9E5353-10CB-492B-8A8F-BA85AA675E87",
    "trigger_id":                 "392C875C-9EC0-49E3-B39A-A37434E78493",
    "error_string":               "not_consented",
    "error_type":                 1
  }
}

Event Properties

Property

Data Type

Description

event_id

UUID

This is a unique Relay identifier used for tracking.

event_name

string

Name of the webhook event.

event_ts

timestamp

Contains the date and time of when the event occurred. The data is in ISO 8601 format.

payload

Contains additional properties that are specific to the event.

ccid

string

The unique identifier of the Customer.

channel_addr

string

Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null.

sms

11 digit mobile number

channel_type

string

Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are:

sms:

Channel target is an SMS notification

client_message_tag

string

An optional, Client created, tag that was provided during the initial messaging/onboarding request.

customer_id

string

The internal, Relay assigned, customer identifier.

event_subtype

string

Identifies the subtype of the event.

event_type

string

Identifies the main event type category.

product_group_id

string

The current product group identifier of the Customer. An account is associated to one and only one product group at a time.

job_id

string

Internal unique job identifier of the originating event. This field is optional and may not always be set.

journey_id

string

The unique Journey identifier that was the originating source of the event.

message_id

string

The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.

message_name

string

The name of the message that was set in the CXB.

notification_id

string

The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.

relay_tracking_id

string

An internal Relay identifier for the event. This value is optional and may be set to null.

trigger_id

string

The unique Trigger identifier that was the originating source of the event.

trigger_name

string

An optional friendly name associated with the experience trigger.

error_string

string

A description of the reason why SMS was not attempted.

error_type

integer

Numeric code 1-6 representing the failure reason.

Error #	Description
1	not_consented
2	duplicate
3	blackout_window
4	no_channel_found_for_customer
5	deactivated
6	sms_throttle

Event: notification.delivered

This event is emitted when Relay receives confirmation, from our SMS aggregator, that the SMS message was successfully delivered to the mobile device.

Example Event Object

{
    "event_name": "notification.delivered",
    "event_id": "D63B8F3D-B526-47F4-BE79-B90562A7F27D",
    "event_ts": "2021-04-27T22:17:21.716Z",
    "payload": {
        "ccid": "1001",
        "channel_addr": "11005551212",
        "channel_type": "sms",
        "client_id": "onelifehealth",
        "client_message_tag": "",
        "client_trigger_id": "",
        "customer_id": "0488ACA1-1D46-4495-AE1C-5D67248378FC",
        "event_type": "notification",
        "event_subtype": "delivered",
        "product_group_id": "default",
        "job_id": "B5D51B2D-2330-410D-9C0D-1864290C6026"
        "journey_id": "FFFA94BA-4C1F-4009-BFFB-A9AB3DCDCAFA",
        "message_id": "F2AC5CCF-5514-4FEA-8975-A78BC072528B",
        "message_name": "Welcome",
        "notification_id": "B5286630-18F2-46F3-A48C-B424EFDCEBAE",
        "relay_tracking_id": "",
        "trigger_id": "75509C9A-FCCE-43A6-B3AC-EA8FECD90230",
    }
}

Event Properties

Property	Data Type	Description
event_name	string	Name of the webhook event.
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
ccid	string	The unique identifier of the Customer.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
client_id	string	The unique identifier of the Client.
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
client_trigger_id	string	An optional, Client provided, trigger id value.
customer_id	string	The internal, Relay assigned, customer identifier.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
journey_id	string	The unique Journey identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
message_name	string	The name of the message that was set in the CXB.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.

Event: notification.undelivered

This event is emitted when Relay receives confirmation, from our SMS aggregator, that the SMS message was not delivered to the mobile device.

Example Event Object

{
    "event_name": "notification.undelivered",
    "event_id": "D63B8F3D-B526-47F4-BE79-B90562A7F27D",
    "event_ts": "2021-04-27T22:17:21.716Z",
    "payload": {
        "ccid": "1001",
        "channel_addr": "11005551212",
        "channel_type": "sms",
        "client_id": "onelifehealth",
        "client_message_tag": "",
        "client_trigger_id": null,
        "customer_id": "B449F583-D87A-4B95-B54F-6549F41FDE2F",
        "job_id": "67B14764-713E-420E-8785-379F38E1656B",
        "journey_id": "FFFA94BA-4C1F-4009-BFFB-A9AB3DCDCAFA",
        "message_id": "F2AC5CCF-5514-4FEA-8975-A78BC072528B",
        "message_name": "Welcome",
        "notification_id": "B5286630-18F2-46F3-A48C-B424EFDCEBAE",
        "product_group_id": "default",
        "relay_tracking_id": "",
        "trigger_id": "75509C9A-FCCE-43A6-B3AC-EA8FECD90230",
        "event_type": "notification",
        "event_subtype": "undelivered"
    }
}

Event Properties

Property	Data Type	Description
event_name	string	Name of the webhook event.
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
ccid	string	The unique identifier of the Customer.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
client_id	string	The unique identifier of the Client.
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
client_trigger_id	string	An optional, Client provided, trigger id value.
customer_id	string	The internal, Relay assigned, customer identifier.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
journey_id	string	The unique Journey identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
message_name	string	The name of the message that was set in the CXB.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.

Event: notification_channel.add

This event is emitted when a notification channel is added to a customer account.

webhook event nofitication channel add

Example Event Object

{
    "event_id": "ip-10-0-0-212-1460-1470-72d7a3f2-afa4-4452-a674-9b8eaf3fc9bb-78r",
    "event_ts": "2022-03-29T10:06:47.583Z",
    "payload": {
        "source_channel": "onboarding-api",
        "channel_addr": "11058559276",
        "channel_type": "sms",
        "ccid": "add-a-phone",
        "client_source": "",
        "relay_tracking_id": "",
        "client_id": "relay_network",
        "event_type": "notification_channel",
        "consent_type": "express",
        "job_id": null,
        "customer_id": "661a8f53-220d-4456-948d-4a545f4e9ad0",
        "event_subtype": "add"
    },
    "event_name": "notification_channel.add"
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
source_channel	string	Identifies the source where the event originated from. Example values are: add-phone.api api csr file ivr legacy-onboarding.api onboarding-api onboarding.file phone-management-add.file sign-up-page sms_conversation stop-conversation wire.message
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
ccid	string	The unique identifier of the Customer.
client_source	string	Identifies the secondary source where the event originated from. This value can be passed in during a phone add process by Client.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
client_id	string	The unique identifier of the Client.
event_type	string	Identifies the main event type category.
consent_type	string	Specifies the type of consent assigned to Customer's or Patient's phone number. Valid values are: written The phone number will have express written consent. express The phone number will have express consent. stop The phone number will have stop consent.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
customer_id	UUID	The internal, Relay assigned, customer identifier.
event_subtype	string	Identifies the subtype of the event.
event_name	string	Name of the webhook event.

Event: notification_channel.remove

This event is emitted when a notification channel is removed from a customer account.

webhook event account deactivate flow

Example Event Object

{
  "event_id": "ip-10-0-0-212-1460-14gq-5933015c-6bf3-4550-bb3f-fbf9dc77c1c3-1cah",
  "event_ts": "2022-03-29T10:06:48.954Z",
  "payload": {
    "source_channel": "file",
    "channel_addr": "11058559276",
    "channel_type": "sms",
    "ccid": "remove-a-phone",
    "client_source": "neustar",
    "relay_tracking_id": "",
    "client_id": "relay_network",
    "event_type": "notification_channel",
    "consent_type": "",
    "job_id": null,
    "customer_id": "1747bce1-cca2-4a1f-bbd0-a964fded3045",
    "event_subtype": "remove"
  },
  "event_name": "notification_channel.remove"
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
source_channel	string	Identifies the source where the event originated from. Example values are: add-phone.api api csr file ivr legacy-onboarding.api onboarding-api onboarding.file phone-management-add.file sign-up-page sms_conversation stop-conversation wire.message
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
ccid	string	The unique identifier of the Customer.
client_source	string	Identifies the secondary source where the event originated from. This value can be passed in during a phone add process by Client.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
client_id	string	The unique identifier of the Client.
event_type	string	Identifies the main event type category.
consent_type	string	Specifies the type of consent assigned to Customer's or Patient's phone number. Valid values are: written The phone number will have express written consent. express The phone number will have express consent. stop The phone number will have stop consent.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
customer_id	UUID	The internal, Relay assigned, customer identifier.
event_subtype	string	Identifies the subtype of the event.
event_name	string	Name of the webhook event.

Event: notification.auth_link_used

This event is emitted when a user clicks and auth_link and navigates to the related message in the Feed.

If the user clicks an auth_lnk and is taken to a verification page or passcode page and the user does not complete that action, this event will not be emitted. This event is only emitted when the user views the actual message (related to the auth_link) in the Feed.

Example Event Object

{
    "event_id": "568C69C9-702D-478B-BC00-923C3F9F3BDD",
    "event_name": "notification.auth_link_used",
    "event_ts": "2018-01-01T12:00:00.000Z",
    "payload": {
        "ccid": "1000-aa-13CE",
        "client_id": "onelifehealth",
        "client_message_tag": "",
        "channel_addr": "10005551212",
        "channel_type": "sms",
        "customer_id": "9006E214-5261-4736-9192-B0ADD3005723",
        "job_id": "A689672A-0A6E-4E99-8C5D-1CAD3728CA32",
        "journey_id": "44BE6B5D-26B1-40EA-9750-2E8C82067AF6",
        "message_id": "3AE05D87-B00E-42E7-9D68-C16C73B68162",
        "message_name": "nickname",
        "notification_id": "8BD6EBD9-94F4-4746-82DA-542E98D86823",
        "product_group_id": "default",
        "relay_tracking_id": "99999999-8888-7777-6666-555555555555",
        "trigger_id": "F9564106-C25A-4FD2-A9DF-F26ADC1D1362"
    }
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
ccid	string	The unique identifier of the Customer.
client_id	string	The unique identifier of the Client.
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
customer_id	string	The internal, Relay assigned, customer identifier.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
journey_id	string	The unique Journey identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
message_name	string	The name of the message that was set in the CXB.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.

Event: powerups_data.received

This event is emitted when Relay receives a submitted customer response to a Power-Ups prompt.

Example Event Object

{
  "event_id": "321B76GR-F251-1234-C15D-EF11C31FB2C4",
  "event_name": "powerups_data.received",
  "event_ts": "2021-09-27T13:08:00.745Z",
  "payload": {
    "ccid": "1232242102",
    "customer_id": "f3370e02-cbca-4e96-8b3b-b00704fc48f3",
    "journey_id": "9b096947-e604-48ec-9808-705bbb16cd66",
    "trigger_id": "73936fa9-7616-4d27-a45a-16258f5d7bdb",
    "message_id": "d1aa0fda-fa83-48d5-91d5-30f9fcf6a9c4",
    "product_group_id": "default",
    "form_id": "form::f5992138-bf55-53c0-b3d9-be8193b1cf91",
    "date_submitted_at": "1631888918000",
    "relay_tracking_id": "9b034851-e406-84ec-9808-705bbb16cd66",
    "client_message_tag": "Test message tag",
    "client_trigger_id": "bonjour",
    "secondary_account_id": "9348234823723",
    "submission_id": "852b8361-1edf-5279-85c3-03c9fae8c879",
    "submission": [
      {
        "answer_id": "name_first",
        "type": "name-first",
        "value": "Testing"
      },
      {
        "answer_id": "name_last",
        "type": "name-last",
        "value": "Hello"
      },
      {
        "answer_id": "email4",
        "type": "email",
        "value": "[email protected]"
      }
    ]
  }
}

Event Properties

Property	Data Type	Description
event_name	string	Name of the webhook event.
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
payload		Contains additional properties that are specific to the event.
ccid	string	The unique identifier of the Customer.
customer_id	string	The internal, Relay assigned, customer identifier.
journey_id	string	The unique Journey identifier that was the originating source of the event.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
form_id	string	The unique identifier of the form filled out by the customer
date_submitted_at	string	The timestamp of when the customer submitted their answers in unix ms format.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
client_message_tag	string	An optional, Client created, tag that was provided during the initial messaging/onboarding request.
client_trigger_id	string	An optional, Client provided, trigger id value.
secondary_account_id	string	This field can be used to tie the Customer back to another external system.
submission_id	string	The unique identifier of the Power-Ups submission.
submission	array	Contains a list of customer answers to questions asked by the Power-Ups form. Each answer will be an object type and will contain the following properties: answer_id [string] Identifier of answer, maps to question id type [string] Question/answer type value [string] Customer answer to question.

Event: powerups_data.artifact_available

This event is emitted when a new file is written to the File Scanner output bucket. The PowerUps API receives an API call to generate the appropriate “File Available” platform event.

Example Event Object

{
  "event_id": "2900f894-bad4-41a7-829d-019afc5a03fd",
  "event_name": "powerups_data.artifact_available",
  "event_type": "powerups_data",
  "event_subtype": "artifact_available",
  "source_name": "rn-powerups-api",
  "source_action": "powerups-artifact-available",
  "event_ts": "2024-10-02T17:21:52.393Z",
  "service_version": 1,
  "ccid": "ccid",
  "client_id": "client",
  "event_version": 3,
  "tracking_id": "ac80d632-a3f0-4ddb-b48b-ce82a97fa161",
  "payload": {
    "clientId": "client",
    "submissionId": "submission",
    "questionId": "question",
    "fileIndex": "0",
    "size": 10000,
    "bucket": "test_bucket",
    "extension": "jpg",
    "s3Key": "test/test/client/question_0_submission.jpg"
  }
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_name	string	Name of the webhook event.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
source_name	string	The name of the source that generated the event.
source_action	string	The action performed by the source that triggered the event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
ccid	string	The unique identifier of the Customer.
client_id	string	The unique identifier of the Client.
payload		Contains additional properties that are specific to the event.
submissionId	string	The unique identifier of the Power-Ups submission.
questionId	string	The unique identifier of the question associated with the submission.
fileIndex	string	The index of the file in the submission.
size	integer	The size of the file in bytes.
bucket	string	The name of the S3 bucket where the file is stored.
extension	string	The file extension.
s3Key	string	The s3 key for the file.

Event: text_message.received

This event is emitted when Relay receives an SMS message from our aggregator with the contents of the text message obtained from the carrier originating from the mobile device.

Example Event Object

{
    "event_id": "68EB7899-28D1-4546-9F97-F6E76EE9C184",
    "event_name": "text_message.received",
    "event_ts": "2018-10-16T13:08:00.745Z",
    "payload": {
        "event_type":           "text_message",
        "event_subtype":        "received",
        "message_id":           "1ffdca03-714e-4280-8681-3d3a33f38043",
        "client_id":            "onelifehealth",
        "ccid":                 "9999",
        "journey_id":           "97s34a57-2816-489a-b78c-a4310abf232b",
        "notification_id":      "8BD6EBD9-94F4-4746-82DA-542E98D86823",
        "product_group_id":     "default",
        "trigger_id":           "8945B43E-A68E-434C-B5F1-FAC1A5731B0C",
        "client_trigger_id":    "bonjour",
        "a2w_mo_ref_id":        "255890070920",
        "carrier":              "tmobile",
        "channel_type":         "sms",
        "country_code":         "1",
        "device_address":       "15202489722",
        "inbound_address":      "73529",
        "message":              "Stop all",
        "message_orig":         "Stop all"
    }
}

Event Properties

Property	Data Type	Description
event_id	UUID	This is a unique Relay identifier used for tracking.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
relay_tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
payload		Contains additional properties that are specific to the event.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
message_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
client_id	string	The unique identifier of the Client.
ccid	string	The unique identifier of the Customer.
journey_id	string	The unique Journey identifier that was the originating source of the event.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
client_trigger_id	string	An optional, Client provided, trigger id value.
a2w_mo_ref_id	string	A unique system generated message ID used by the sms aggregator.
carrier	string	The carrier associated with the mobile number (i.e., Verizon, T-mobile, and AT&T, etc.)
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
country_code	string	The country code associated with the mobile number. E.g. ‘1’ for US mobile numbers, ’44’ for UK, etc.
device_address	string	The mobile number of the text sender (i.e, a customer or patient) received from the carrier.
inbound_address	string	The address field received from the carrier (normally a short code or sender id) to which the text sender is responding.
message	string	Filtered version of the original message body or content of the text. The system filters out certain matching regular expressions from MOs, such as: “Re:”, “In Reply To.”, “-----Original Message-----“, etc. as these prefixes may be automatically inserted by the end-user’s device to mobile originated messages.
message_orig	string	The message body or content of the text as originally sent by the customer or patient from their mobile device.

Event: twoway.agent_ping

This event is emitted when an agent sends a ping message in a two-way communication.

Example Event Object

{
  "event_type": "twoway",
  "event_subtype": "agent_ping",
  "event_name": "twoway.agent_ping",
  "event_ts": "2024-07-08T19:27:39.233Z",
  "event_id": "717d32b4-43b2-4eac-bc0b-9b016303c941",
  "tracking_id": "dc845c23-d657-4fd6-b5c2-0e003d8f8352",
  "payload": {
    "agent_last_name": "Joe",
    "agent_first_name": "Doran",
    "product_group_id": "default",
    "tags": "ebbd5929-37d6-43e8-9308-a68d09521ae2",
    "message_id": "a259283c-febf-4508-85a4-cd0cde2bab70",
    "client_id": "relay",
    "agent_id": "d61bb330-c357-4ec7-8657-1cc715e502a7",
    "journey_id": "0c6d5cfc-9b0f-4ae4-a90c-491f0bc4fc11",
    "customer_id": "c8549fa5-ae29-474f-b0e3-f67e8a4dd994",
    "channel_sid": "CH19a6f61830e54f3386dd6f95b06cbe82",
    "is_in_blackout_window": false,
    "conversation_status": "f4fab74f-2727-48de-8e26-6c50ba1576df"
  }
}

Event Properties

Property	Data Type	Description
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
event_id	UUID	This is a unique Relay identifier used for tracking.
tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
payload		Contains additional properties that are specific to the event.
agent_last_name	string	CX Portal User's (Agent's) Last Name.
agent_first_name	string	CX Portal User’s (Agent's) First Name.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
tags	UUID	The unique identifier of the tags associated with the message.
message_id	UUID	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
client_id	string	The unique identifier of the Client.
agent_id	UUID	The unique identifier of the agent.
journey_id	UUID	The unique Journey identifier that was the originating source of the event.
customer_id	UUID	The internal, Relay assigned, customer identifier.
channel_sid	string	The unique identifier of the channel. This value is encrypted.
is_in_blackout_window	boolean	Indicates whether the event occurred within a blackout window.
conversation_status	UUID	The state of the conversation at the time of this event.

Event: twoway.channel_closed

This event is emitted when a two-way communication channel is closed.

Example Event Object

{
  "event_type": "twoway",
  "event_subtype": "channel_closed",
  "event_name": "twoway.channel_closed",
  "event_version": 2,
  "event_ts": "2024-07-08T19:27:45.474Z",
  "event_id": "f0de91e5-5cd6-4b5d-b197-65fb4f3cffec",
  "client_id": "relay",
  "tracking_id": "8c9f1e0e-a360-43e9-bbec-430ab3286c18",
  "payload": {
    "agent_last_name": "Joe",
    "agent_first_name": "Doran",
    "product_group_id": "default",
    "tags": "ebbd5929-37d6-43e8-9308-a68d09521ae2",
    "journey_id": "0c6d5cfc-9b0f-4ae4-a90c-491f0bc4fc11",
    "message_id": "a259283c-febf-4508-85a4-cd0cde2bab70",
    "client_id": "ann_permi",
    "agent_id": "d61bb330-c357-4ec7-8657-1cc715e502a7",
    "customer_id": "c8549fa5-ae29-474f-b0e3-f67e8a4dd994",
    "channel_sid": "CH19a6f61830e54f3386dd6f95b06cbe82",
    "is_in_blackout_window": false,
    "conversation_id": "f4fab74f-2727-48de-8e26-6c50ba1576df"
  }
}

Event Properties

Property	Data Type	Description
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
event_name	string	Name of the webhook event.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
event_id	UUID	This is a unique Relay identifier used for tracking.
client_id	string	The unique identifier of the Client.
tracking_id	string	An internal Relay identifier for the event. This value is optional and may be set to null.
payload		Contains additional properties that are specific to the event.
agent_last_name	string	CX Portal User's (Agent's) Last Name.
agent_first_name	string	CX Portal User’s (Agent's) First Name.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
tags	UUID	The unique identifier of the tags associated with the message.
journey_id	UUID	The unique Journey identifier that was the originating source of the event.
message_id	UUID	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
agent_id	UUID	The unique identifier of the agent.
customer_id	UUID	The internal, Relay assigned, customer identifier.
channel_sid	string	The unique identifier of the channel. This value is encrypted.
is_in_blackout_window	boolean	Indicates whether the event occurred within a blackout window.
conversation_id	UUID	A unique identifier for the conversation based on when a channel is opened or closed.

Event: twoway_webhook.agent_message

This event is emitted when an agent sends a message in a two-way communication via a webhook. The event contains details about the agent, customer, and the message.

Example Event Object

{
  "event_name": "twoway_webhook.agent_message_sent",
  "event_type": "twoway_webhook",
  "event_subtype": "agent_message_sent",
  "event_id": "31338705-9f47-4e90-8d21-033e39fd928c",
  "event_ts": "2024-07-08T20:08:04.864Z",
  "data_key": null,
  "source_name": "twilio",
  "source_action": "webhook",
  "job_id": null,
  "ccid": null,
  "channel_addr": null,
  "channel_type": null,
  "client_id": "ann_permi",
  "client_trigger_id": null,
  "customer_id": null,
  "journey_id": null,
  "message_id": null,
  "notification_id": null,
  "product_group_id": null,
  "trigger_id": null,
  "payload": {
    "tag_id": "ebbd5929-37d6-43e8-9308-a68d09521ae2",
    "conversation_id": "370d20ce-bdf4-46c8-a987-c3b14a5c1945",
    "client_id": "relay",
    "sender_type": "agent",
    "sender_id": "d61bb330-c357-4ec7-8657-1cc715e502a7",
    "agent_id": "d61bb330-c357-4ec7-8657-1cc715e502a7",
    "channel_sid": "CH77ef9a2d44644a76801aea124a7e0028",
    "message_sid": "IMfdfc64f5359d426eaa0a81cac2369150",
    "message_idx": "2",
    "body": "xKzUn/NUT3v2BkzddR4V9w==/S8y2SSNIlfodpJjPmimdA==",
    "from": "agent::relay::d61bb330-c357-4ec7-8657-1cc715e502a7",
    "date_created": "2024-07-08T20:08:04.615Z",
    "tags": "ebbd5929-37d6-43e8-9308-a68d09521ae2"
  }
}

Event Properties

Property	Data Type	Description
event_name	string	Name of the webhook event.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
data_key	string	A key that identifies the specific data associated with the event.
source_name	string	The name of the source that generated the event.
source_action	string	The action performed by the source that triggered the event.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
ccid	string	The unique identifier of the Customer.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
client_id	string	The unique identifier of the Client.
client_trigger_id	string	An optional, Client provided, trigger id value.
customer_id	UUID	The internal, Relay assigned, customer identifier.
journey_id	UUID	The unique Journey identifier that was the originating source of the event.
message_id	UUID	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
payload		Contains additional properties that are specific to the event.
tag_id	UUID	The unique identifier of the tag associated with the event.
conversation_id	UUID	A unique identifier for the conversation based on when a channel is opened or closed.
sender_type	string	Text indicating the type of sender for this event. Possible values are "agent", "customer", "system".
sender_id	UUID	The unique identifier of the sender.
agent_id	UUID	The unique identifier of the agent.
channel_sid	string	The unique identifier of the channel. This value is encrypted.
message_sid	string	The unique identifier of the message. This value of encrypted.
body	string	The body content of the message. This value is encrypted.
from	string	The sender's address.
date_created	timestamp	The date and time when the message was created. The data is in ISO 8601 format.
tags	UUID	The unique identifier of the tags associated with the message.

Event: twoway_webhook.customer_message

This event is emitted when a customer sends a message in a two-way communication via a webhook. The event contains details about the customer, the message, and the conversation.

Example Event Object

{
  "event_name": "twoway_webhook.customer_message_sent",
  "event_type": "twoway_webhook",
  "event_subtype": "customer_message_sent",
  "event_id": "046868be-3e74-4217-918f-f03a21cecc92",
  "event_ts": "2024-07-08T18:36:38.581Z",
  "job_id": null,
  "ccid": null,
  "channel_addr": null,
  "channel_type": null,
  "client_trigger_id": null,
  "journey_id": null,
  "message_id": null,
  "notification_id": null,
  "product_group_id": null,
  "trigger_id": null,
  "payload": {
    "tag_id": "f7e88b9c-2443-44ad-8de6-494bd88a786b",
    "conversation_id": "0bbcdb14-367f-4dc9-9a5f-ffc5399b2c2e",
    "client_id": "relay",
    "sender_type": "customer",
    "sender_id": "9621b5e3-34e6-4995-a7d0-6a5fdaaab755",
    "customer_id": "9621b5e3-34e6-4995-a7d0-6a5fdaaab755",
    "channel_sid": "CH410f427ccdce456ba321d3d7b0e9fbd2",
    "message_sid": "IM4d65f1391bf3450bbb9e45822f012dd0",
    "message_idx": "7",
    "body": "rhM7U8LdRhGPm+1ar49Vvw==dlN0l47d9r4Ce0pS2UaJ3w==",
    "from": "customer::relay::9621b5e3-34e6-4995-a7d0-6a5fdaaab755",
    "date_created": "2024-07-08T18:36:36.216Z",
    "tags": "f7e88b9c-2443-44ad-8de6-494bd88a786b"
  }
}

Event Properties

Property	Data Type	Description
event_name	string	Name of the webhook event.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
ccid	string	The unique identifier of the Customer.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
client_id	string	The unique identifier of the Client.
client_trigger_id	string	An optional, Client provided, trigger id value.
customer_id	UUID	The internal, Relay assigned, customer identifier.
journey_id	UUID	The unique Journey identifier that was the originating source of the event.
message_id	UUID	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
payload		Contains additional properties that are specific to the event.
tag_id	UUID	The unique identifier of the tag associated with the event.
conversation_id	UUID	A unique identifier for the conversation based on when a channel is opened or closed.
sender_type	string	Text indicating the type of sender for this event. Possible values are "agent", "customer", "system".
sender_id	UUID	The unique identifier of the sender.
agent_id	UUID	The unique identifier of the agent.
channel_sid	string	The unique identifier of the channel. This value is encrypted.
message_sid	string	The unique identifier of the message. This value of encrypted.
body	string	The body content of the message. This value is encrypted.
from	string	The sender's address.
date_created	timestamp	The date and time when the message was created. The data is in ISO 8601 format.
tags	UUID	The unique identifier of the tags associated with the message.

Event: twoway_webhook.system_message

This event is emitted when a system sends a message in a two-way communication via a webhook. The event contains details about the system message and the conversation.

Example Event Object

{
  "event_name": "twoway_webhook.system_message_sent",
  "event_type": "twoway_webhook",
  "event_subtype": "system_message_sent",
  "event_id": "0574b32f-0996-4dcb-b93e-9fe083f8adc8",
  "event_ts": "2024-07-08T14:52:12.630Z",
  "data_key": null,
  "source_name": "twilio",
  "source_action": "webhook",
  "job_id": null,
  "ccid": null,
  "channel_addr": null,
  "channel_type": null,
  "client_id": null,
  "client_trigger_id": null,
  "customer_id": null,
  "journey_id": null,
  "message_id": null,
  "notification_id": null,
  "product_group_id": null,
  "trigger_id": null,
  "payload": {
    "conversation_id": "5e2a0c94-5d31-45a7-bde9-943e395f4aff",
    "sender_type": "system",
    "channel_sid": "CHf40307076a604e1282f2ed7b323b3905",
    "message_sid": "IM5d4f04c29bee4a1bb89075a8013c6004",
    "message_idx": "0",
    "body": "Auto response",
    "from": "system",
    "date_created": "2024-07-08T14:52:12.449Z",
    "tags": null,
    "client_id": "relay"
  }
}

Event Properties

Property	Data Type	Description
event_name	string	Name of the webhook event.
event_type	string	Identifies the main event type category.
event_subtype	string	Identifies the subtype of the event.
event_id	UUID	This is a unique Relay identifier used for tracking.
event_ts	timestamp	Contains the date and time of when the event occurred. The data is in ISO 8601 format.
data_key	string	A key that identifies the specific data associated with the event.
source_name	string	The name of the source that generated the event.
source_action	string	The action performed by the source that triggered the event.
job_id	string	Internal unique job identifier of the originating event. This field is optional and may not always be set.
ccid	string	The unique identifier of the Customer.
channel_addr	string	Contains the channel address. The value and format will be different based on the channel_type value. The value is optional and may be set to null. sms 11 digit mobile number
channel_type	string	Identifies the channel type of the channel_addr field. The value is optional and may be set to null. Valid values are: sms: Channel target is an SMS notification
client_id	string	The unique identifier of the Client.
client_trigger_id	string	An optional, Client provided, trigger id value.
customer_id	UUID	The internal, Relay assigned, customer identifier.
journey_id	UUID	The unique Journey identifier that was the originating source of the event.
message_id	UUID	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
notification_id	string	The unique, internal, identifier associated with the source notification. The value is optional and may be set to null.
product_group_id	string	The current product group identifier of the Customer. An account is associated to one and only one product group at a time.
trigger_id	string	The unique Trigger identifier that was the originating source of the event.
payload		Contains additional properties that are specific to the event.
conversation_id	UUID	A unique identifier for the conversation based on when a channel is opened or closed.
sender_type	string	Text indicating the type of sender for this event. Possible values are "agent", "customer", "system".
channel_sid	string	The unique identifier of the channel. This value is encrypted.
message_sid	string	The unique identifier of the message. This value of encrypted.
body	string	The body content of the message. This value is encrypted.
from	string	The sender's address.
date_created	timestamp	The date and time when the message was created. The data is in ISO 8601 format.
tags	UUID	The unique identifier of the tags associated with the message.

Was this article helpful?

What's Next

Vanity URL