Add a new Webhook to your VidCorp account
To add a new webhook using the VidCorp web application:
- Click on the Settings menu in your VidCorp account
- Select Webhooks from the drop-down menu
- Click the Create button
- Choose the event type you want to listen for (for example when a message is sent, delivered, email opened, etc)
- Add your webhook URL under Post To URL (must be SSL-encrypted for security)
- Give your webhook a name under Name
- 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 VidCorp 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. Vidcorp 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) VidCorp will retry up to 5 times. If the final (5th) retry also fails, VidCorp will usually wait 24 hours before trying again.
Webhooks can be triggered by various events which happen on the VidCorp platform. There are several types of events which can be configured to send you data to your webhook URL:
|message_polling||Message was processed and is ready to send|
|message_pushed||Message was sent|
|message_delivered||Message was successfully delivered|
|message_delivery_error||Delivery failed – message was not delivered|
|message_received||A response to your message was received from someone|
|message_received_mms||An inbound MMS message was received from someone|
|message_opened||An email message was opened by its recipient|
|impression||“Landing Page” was viewed (these are from links in the sent message)|
|unsubscribe||Contact opted out of future campaigns|
|unsubscribe_track||Contact clicked on unsubscribe link|
|clicktrack||Contact clicked on a link (not an unsubscribe link)|
|form_submission||Form was submitted (on a Landing Page)|
|video_play||Video was played (on a Landing Page)|
|video_complete||Video was watched right to the end|
|scratchie_initiated||“Scratchie” has been rendered (on a Landing Page)|
|scratchie_interact||Contact interacted with the Scratchie|
View a detailed description of the data format for webhooks.
Try our troubleshooting guide if you are having any problems during testing.