Update a webhook

PUT  https://:account.api-us1.com/api/3/webhooks/id

• JSON

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

 

200 OK

{
  "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"
  }
}

PATH PARAMS

id                                                      REQUIRED

int32                                                The webhook id

 

BODY PARAMS

webhook

object

 

webhook.name

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

 

webhook.url

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

 

webhook.events

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

 

webhook.sources

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).