Add Webhook to list

Create a new webhook. Please bear in mind that although you can choose which events you want to receive, you must pick at least one.

Endpoint

POST /lists/:uuid/webhooks


Required parameters

api_token string
Your api_token.

uuid string
Your list UUID.

url string
Your webhook's url.

Optional parameters

event_new_subscriber boolean
If set to true this webhook will be triggered when a new subscriber is added to the list.

event_subscriber_promoted boolean
If set to true this webhook will be triggered when a new subscriber is promoted.

event_subscriber_deleted boolean
If set to true this webhook will be triggered when a subscriber is deleted.

event_reward_unlocked boolean
If set to true this webhook will be triggered when a reward is unlocked (e.g: when a subscriber invites 5 friends and a reward has been set for 5 referrals).

event_new_conversion boolean
If set to true this webhook will be triggered when a conversion is tracked.


Example response

{
  "status": "ok",
  "data": {
    "response": "webhook_created",
    < Webhook object >
  },
  "calls_left": 1000,
  "timestamp": 1549279876
}

Webhook Object

Still need help? Contact Us Contact Us