DailyStory Webhooks

A webhook is a URL that DailyStory will send an HTTP POST with related data to when events occur within DailyStory. Using a webhook enables your application to receive notifications for events.

Manage Webhooks

To manage webhooks navigate to Account Settings > Developer > Webhooks:

Test a Webhook

In the manage webhooks screen you can also test your webhook.

Delivery and Retries

DailyStory tracks delivery failures per webhook subscription. If a webhook returns a non-2xx HTTP response or cannot be reached for 10 consecutive attempts, the subscription is automatically paused. Paused webhooks stop receiving events until an administrator clicks Activate on the Manage Webhooks page, which also resets the failure counter. Individual failures (HTTP status and response body, or exception message) are captured in the Webhook Failure Log under Admin > Logs and Tools for diagnostic purposes.

Manage Webhooks using REST API

Subscribe and unsubscribe to webhooks using the Subscription API.

Supported Webhook Events

Below are the webhook events supported by DailyStory:

Contact Created or Updated

Returns the full serialized contact (see contact object).

{ "contact": { /* full serialized contact - see contact object */ } }

Contact Create or Update Failed

This webhook is called when the creation or update of a contact fails. The body of this webhook will contain 2 objects. The serialized exception and the original object that was received.

Important

This webhook is only available for specific integrations that utilize webhooks for contact creation/update.

{ "exception": [exception details], "payload": [serialized version of update object] }

Lead Created

When a new lead is created.

{ "id":[numeric id of the lead], "dsid":"[unique id of the contact]" }

Lead Status Changed

When the status of a lead is changed.

{ "id":[numeric id of the lead], "dsid":"[unique id of the contact]", "status":"[status changed to, e.g. Deleted ]" }

Contact Status Changed

When the status of a contact is changed.

{ "dsid":"[unique id of the contact]", "status":"[status changed to, e.g. Deleted ]" }

URL Shortener Clicked

When a URL Shortener is clicked.

{ "id":"unique id of the link" }

Text Message Reply Received

When a contact replies to a text message.

{ "dsid":"[unique id of the contact]", "mobile":"[mobile number that replied]", "message":"[received reply]" }

Email Address Bounced

When an email address used to send an email bounces

{ "dsid":"[unique id of the contact]", "email":"[email address that bounced]", "date":"[date/time when email bounced]", "messageid":"[unique email message id of the email that bounced]", "is_spam_complaint":"[bool indicating if the bounce is due to a spam complaint]", "reason":"Permanent Delivery Failure - Address not deliverable" }

The comment of the response will contain additional details for the reason the email address bounced. If a recipient marks the email as SPAM (complaint) this will also trigger this webhook.

Email Opened

When a contact opens a tracked email sent from DailyStory.

{ "dsid":"[unique id of the contact]", "emailid":[numeric id of the email], "date":"[date/time when the email was opened]" }

Email Clicked

When a contact clicks a tracked link in an email sent from DailyStory.

{ "dsid":"[unique id of the contact]", "emailid":[numeric id of the email], "date":"[date/time when the link was clicked]", "url":"[url that was clicked]" }

Opted out of Email

When a contact opts out of email.

{ "dsid":"[unique id of the contact]", "email":"[email address that opted out]" }

Opted out of Text Messaging

When a contact opts out of text messaging.

{ "dsid":"[unique id of the contact]", "mobile":"[mobile number that opted out]" }

Opted out of Phone Calls

When a contact opts out of phone calls.

{ "dsid":"[unique id of the contact]" }

Opted in to Email

When a contact opts in to email.

{ "dsid":"[unique id of the contact]", "email":"[email address that opted in]" }

Opted in to Phone Calls

When a contact opts in to phone calls.

{ "dsid":"[unique id of the contact]" }

Opted in to Text Messaging

When a contact opts in to text messaging.

{ "dsid":"[unique id of the contact]", "mobile":"[mobile number that opted in]" }

Web Form Submitted

When a web form is submitted.

{ "webform_id":"[id of the web form]", "webform_name":"[name of the web form]", "lead_id":[numeric id of the lead], "dsid":"[unique id of the contact]" }

Segment Created

When a new segment is created.

{ "id":"[id of the segment]", "name":"[name of the semgnet]", "description":"[description of the segment]", "segment_type":"[type of segment]", "is_call_list":[true/false] }

Segment Updated

When a segment is updated.

{ "id":"[id of the segment]", "name":"[name of the semgnet]", "status":"[status of the segment]", "description":"[description of the segment]", "segment_type":"[type of segment]", "is_call_list":[true/false] }

See status for details on the values for the status.

User Created

When a new DailyStory user is created (a user is an account that can login to the DailyStory tenant).

{ "email":"[email address of the user created]", "useruid":"[the unique id of the user]" } }