Webhook payloads

The following sections outline the available webhooks and their corresponding payloads.

Subscribe

This event occurs when a user opts in to a subscription.

Parameter Description Example Type Notes
type Type of event sms.subscribed String The following options are available:
  • email.subscribed
  • sms.subscribed
timestamp Timestamp of when the event occured originally 1632945178104 Long
company Company of the originating event
display_name Name of the company that appears in the Attentive platform Hudson & Ivy String
company_id Unique identifier of the company MDc6Q29tcGFueTU String
subscriber User who has opted in
external_id Unique identifier of the subscriber 16467358 Long
phone Phone number of the subscriber +15555555555 String Note that this may not be included if the user only subscribed to receive email
email Email address of the subscriber test@gmail.com String Note that this may not be included if the user only subscribed to receive SMS
external_identifiers Identifiers from 3rd party sources
client_user_id List of client user identifiers tied to the subscriber List Only will be included if a Client user identifier is available.
creative Sign-up source of the subscription
name Name of the sign-up source Text to Join String
type Type of sign-up source TEXT_TO_JOIN String
subtype Subtype of sign-up source CODE String
subscription Subscription metadata of the subscribe event
type The specifc type of subscription MARKETING String The following options are available:
  • MARKETING
  • TRANSACTIONAL

Unsubscribe

This event occurs when a user opts out of a subscription.

Parameter Description Example Type Notes
type Type of event sms.unsubscribed String The following options are available:
  • email.unsubscribed
  • sms.unsubscribed
timestamp Timestamp of when the event occured originally 1632945178104 Long
company Company of the originating event
display_name Name of the company that appears in the Attentive platform Hudson & Ivy String
company_id Unique identifier of the company MDc6Q29tcGFueTU String
subscriber User who has opted in
external_id Unique identifier of the subscriber 16467358 Long
phone Phone number of the subscriber +15555555555 String Note that this may not be included if the user only subscribed to receive email
email Email address of the subscriber test@gmail.com String Note that this may not be included if the user only subscribed to receive SMS
external_identifiers Identifiers from 3rd party sources
client_user_id List of client user identifiers tied to the subscriber List Only will be included if a Client user identifier is available.
subscription Subscription metadata of the unsubscribe event
type The specifc type of subscription MARKETING String The following options are available:
  • MARKETING
  • TRANSACTIONAL

Message Sent

This event occurs when a message is sent.

Parameter Description Example Type Notes
type Type of event sms.sent String The following options are available:
  • sms.sent
timestamp Timestamp of when the event occured originally 1632945178104 Long
company Company of the originating event
display_name Name of the company that appears in the Attentive platform Hudson & Ivy String
company_id Unique identifier of the company MDc6Q29tcGFueTU String
subscriber User who has opted in
external_id Unique identifier of the subscriber 16467358 Long
phone Phone number of the subscriber +15555555555 String Note that this may not be included if the user only subscribed to receive email
email Email address of the subscriber test@gmail.com String Note that this may not be included if the user only subscribed to receive SMS
external_identifiers Identifiers from 3rd party sources
client_user_id List of client user identifiers tied to the subscriber List Only will be included if a Client user identifier is available.
message Message that was sent
id Unique identifier of the message MDc6TWVzc2FnZTEyNzI1MA String
type The type of message sent ONE_TIME String

Message Link Clicked

This event occurs when a message link is clicked.

Parameter Description Example Type Notes
type Type of event sms.message_link_click String The following options are available:
  • sms.message_link_click
timestamp Timestamp of when the event occured originally 1632945178104 Long
company Company of the originating event
display_name Name of the company that appears in the Attentive platform Hudson & Ivy String
company_id Unique identifier of the company MDc6Q29tcGFueTU String
subscriber User who has opted in
external_id Unique identifier of the subscriber 16467358 Long
phone Phone number of the subscriber +15555555555 String Note that this may not be included if the user only subscribed to receive email
email Email address of the subscriber test@gmail.com String Note that this may not be included if the user only subscribed to receive SMS
external_identifiers Identifiers from 3rd party sources
client_user_id List of client user identifiers tied to the subscriber List Only will be included if a Client user identifier is available.
message_link_click Message link that was clicked
message_id GID of Message Id 99720 String
link_target The link target https://testsite.com/ String
message_type The type of message sent AUTOMATED String

Custom Attribute Set

This event occurs when a custom attribute is set.

Parameter Description Example Type Notes
type Type of event custom_attribute.set String
timestamp Timestamp of when the event occured originally 1632945178104 Long
company Company of the originating event
display_name Name of the company that appears in the Attentive platform Hudson & Ivy String
company_id Unique identifier of the company MDc6Q29tcGFueTU String
subscriber User who has opted in
external_id Unique identifier of the subscriber 16467358 Long
phone Phone number of the subscriber +15555555555 String Note that this may not be included if the user only subscribed to receive email
email Email address of the subscriber test@gmail.com String Note that this may not be included if the user only subscribed to receive SMS
external_identifiers Identifiers from 3rd party sources
client_user_id List of client user identifiers tied to the subscriber List Only will be included if a Client user identifier is available.
user_property Information about the user property
id GID of user property MTY6Q3VzdG9tUHJvcGVydHlJZGlkOiAiMjg3Igo String
name The name of the property Favorite Color String
value The value of the property Blue String