Create a webhook

POST  https://:account.api-us1.com/api/3/webhooks

• JSON

{
    "webhook": {
      "name": "My Hook",
      "url": "http://example.com/my-hook",
      "events": [
        "subscribe",
        "unsubscribe",
        "sent"
      ],
      "sources": [
        "public",
        "system"
      ]
    }
}

 

201 Created

{
  "webhook": {
    "cdate": "2016-01-01T12:00:00-00:00",
    "listid": "0",
    "name": "My Hook",
    "url": "http://example.com/my-hook",
    "events": [
      "subscribe",
      "unsubscribe",
      "sent"
    ],
    "sources": [
      "public",
      "system"
    ],
    "links": [],
    "id": "1"
  }
}

BODY PARAMS

webhook

object

 

webhook.name                                 REQUIRED

string                                                A name (or label) to give this webhook.

 

webhook.url                                     REQUIRED

string                                                The URL where the webhook will send the POST request when the event occurs.

 

webhook.events                               REQUIRED

array of strings                                   The event(s) that will trigger the webhook to fire.

 

webhook.sources                              REQUIRED

array of strings                                   The source(s) causing an event to occur.

 

webhook.listid

int32                                                  The id of a list associated with an event (required for some events).