​
Webhook Events

The Tatango Webhooks system allows you to subscribe to real-time notifications when something important happens in your account. The table below lists the event types currently available.

Webhook EventDescription
SubscribesOccurs when a new number has subscribed to your list
UnsubscribesOccurs when a subscriber unsubscribes from your list
Message SentOccurs when a broadcast message is sent
Reply ReceivedOccurs when a reply to a message from your shortcode is received
Subscriber CleanedOccurs when a subscriber is cleaned from your list
Each webhook event has a JSON payload whose schema is documented in the sections below.

​
Subscribe Event

PropertyTypeDescription
typestringAlways "subscribe"
timestampstringISO 8601 timestamp of the event
account_idintegerTatango account identifier
campaign_idintegerList identifier
opt_idintegerUnique identifier for the opt-in event
phone_numberstringSubscriber’s phone number
carrier_idintegerCarrier identifier
carrier_namestringName of the carrier
first_namestringSubscriber’s first name
last_namestringSubscriber’s last name
email_addressstringSubscriber’s email address
genderstringSubscriber’s gender
zip_codestringSubscriber’s ZIP code
birthdatestringSubscriber’s birth date (MM/DD/YYYY)
birthdaystringSubscriber’s birthday (MM/DD)
tag_listarrayArray of tags associated with the subscriber
first_opt_in_timestampstringISO 8601 timestamp of first opt-in
last_opt_in_methodstringMethod used for the opt-in
last_opt_in_keywordstringKeyword used for opt-in (if applicable)
total_messages_receivedintegerTotal messages received by subscriber

​
Unsubscribe Event

PropertyTypeDescription
typestringAlways "unsubscribe"
timestampstringISO 8601 timestamp of the event
unsubscribe_datestringISO 8601 timestamp of unsubscribe action
account_idintegerTatango account identifier
campaign_idintegerList identifier
opt_idintegerUnique identifier for the opt event
phone_numberstringSubscriber’s phone number
carrier_idintegerCarrier identifier
carrier_namestringName of the carrier
first_namestringSubscriber’s first name
last_namestringSubscriber’s last name
email_addressstringSubscriber’s email address
genderstringSubscriber’s gender
zip_codestringSubscriber’s ZIP code
birthdatestringSubscriber’s birth date
birthdaystringSubscriber’s birthday
tag_listarrayArray of tags associated with the subscriber
first_opt_in_timestampstringISO 8601 timestamp of first opt-in
last_opt_in_methodstringLast method used for opt-in
last_opt_in_keywordstringLast keyword used for opt-in
total_messages_receivedintegerTotal messages received by subscriber

​
Message Sent Event

PropertyTypeDescription
typestringAlways "message_sent"
timestampstringISO 8601 timestamp of the event
account_idintegerTatango account identifier
campaign_idintegerList identifier
message_idintegerUnique identifier for the message
message_namestringName of the message
sent_timestampstringISO 8601 timestamp when message was sent
is_mmsbooleanWhether the message is MMS (true) or SMS (false)
contentstringMessage content
recipient_countstringNumber of intended recipients
success_countintegerNumber of successful deliveries
bounce_countintegerNumber of bounced messages
clean_countintegerNumber of cleaned subscribers
unsubscribe_countintegerNumber of unsubscribes from this message
send_costnumberCost of sending the message

​
Reply Received Event

PropertyTypeDescription
typestringAlways "campaign_response"
timestampstringISO 8601 timestamp of the event
account_idintegerTatango account identifier
campaign_idintegerList identifier
message_idintegerID of the message being replied to
sent_timestampstringISO 8601 timestamp of original message
contentstringContent of the original message
response_timestampstringISO 8601 timestamp of the reply
reply_contentstringContent of the subscriber’s reply
opt_idintegerUnique identifier for the opt record
phone_numberstringSubscriber’s phone number
carrier_idintegerCarrier identifier
carrier_namestringName of the carrier
first_namestringSubscriber’s first name
last_namestringSubscriber’s last name
email_addressstringSubscriber’s email address
genderstringSubscriber’s gender
zip_codestringSubscriber’s ZIP code
birthdatestringSubscriber’s birth date
birthdaystringSubscriber’s birthday
tag_listarrayArray of tags associated with the subscriber
first_opt_in_timestampstringISO 8601 timestamp of first opt-in
last_opt_in_methodstringMethod used for opt-in
last_opt_in_keywordstringKeyword used for opt-in
is_mmsbooleanWhether the reply is MMS or SMS
attachment_urlsarrayArray of attachment URLs for MMS replies

​
Subscriber Cleaned Event

PropertyTypeDescription
typestringAlways "cleaned"
timestampstringISO 8601 timestamp of the event
account_idintegerTatango account identifier
campaign_idintegerList identifier
subscriber_idintegerUnique identifier for the subscriber
phone_numberstringSubscriber’s phone number
cleaned_atstringISO 8601 timestamp when subscriber was cleaned
clean_reasonstringReason for the clean action
last_message_idintegerID of the last message sent to subscriber