Managing Webhooks

Modified on Tue, 18 Jul 2023 at 02:30 PM

Webhooks provide a way for Tall Bob to communicate to your application or service about certain events as they occur. You can configure and test webhooks using the Webhooks settings page in your account.

Add a new Webhook to your Tall Bob account

To add a new webhook using the Tall Bob web app:

  1. Click on the Settings menu in your Tall Bob account

  2. Select Webhooks from the drop-down menu

  3. Click the Create button

  4. Choose the event type you want to listen for (for example when a message is sent, delivered, email opened, etc)

  5. Add your webhook URL under Post To URL (must be SSL-encrypted for security)

  6. Give your webhook a name under Name

  7. Click Save



  • Webhook URLs should be secure (start with “HTTPS”) and set up to accept, at a minimum, POST requests. When you provide the URL where you want Tall Bob to POST the data for events, we may do a quick check that the URL exists by using a HEAD request (not POST)

  • You can also test your webhooks, after setting them up. Tall Bob will send a small packet of data which includes a test message and the event type to the URL provided.

  • When sending data to your URL, if it doesn’t exist or returns something other than a Successful HTTP status code (eg 200 or 204) Tall Bob will retry up to 5 times. If the final (5th) retry also fails, Tall Bob will usually wait 24 hours before trying again.


Event Types

Webhooks can be triggered by various events which happen on the Tall Bob platform. There are several types of events that can be configured to send you data to your webhook URL:


Event Type

Description

Webhook Format

message_polling

The message was processed and is ready to send

Message Polling Event Example

message_pushed

Message was sent

Message Pushed Event Example 

message_delivered

The message was successfully delivered

Message Delivered Event Example 

message_delivery_error

Delivery failed – the message was not delivered

Message Delivery Error Event Example 

message_received

A response to your message was received from someone

Message Received Event Example 

message_received_mms

An inbound MMS message was received from someone

Message Received MMS Event Example

message_opened

An email message was opened by its recipient

Message Opened Event Example 

impression

“Landing Page” was viewed (these are from links in the sent message)

Impressions Event Example

unsubscribe

Contact opted out of future campaigns

Unsubscribe Event Example

unsubscribe_track

Contact clicked on an unsubscribe link

Unsubscribe Track Event Example

clicktrack

Contact clicked on a link (not an unsubscribe link)

Clicktrack Event Example

form_submission

The form was submitted (on a Landing Page)

Form Submission Event Example

video_play

The video was played (on a Landing Page)

Video Play Event Example

video_complete

The video was watched right to the end

Video Complete Event Example

scratchie_initiated

“Scratchie” has been rendered (on a Landing Page)

Scratchie Initiated Event Example

scratchie_interact

Contact interacted with the Scratchie

Scratchie Interact Event Example



Helpful Stuff

  • Looking for definitions that revolve around Mobile, SMS and Telco Industries, then click here

  • To know more on the different Webhook Formats click here

  • Other helpful developer documents can be found here

If you ever need further assistance or someone to point you in the right direction you can email the team at support@tallbob.com

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article