Skip to Content
Webhooks

Update a webhook endpoint

Change the URL or event types, or pause and resume. Requires the `webhooks:write` scope.

PATCH
/v1/webhook-endpoints/{id}

Change the URL or event types, or pause and resume.

Requires the webhooks:write scope.

Authorization

secretKey
headerAuthorizationBearer <token>

A secret key: wc_live_... or wc_test_.... Keep it on your server.

Path Parameters

id*string
Match^whk_[0-9A-Za-z]{6,64}$

Request Body

application/json
  1. body
url?string
Formaturi
Lengthlength <= 2048
events?array<>
Items1 <= items <= 50
disabled?boolean

true to pause deliveries, false to resume (also resets the failure count).

Response Body

The updated endpoint.

application/json
  1. response
id*string
Match^whk_[0-9A-Za-z]{6,64}$
mode*string

live or test. Always the mode of the API key that made the request.

Value in"live""test"
url*string
events*array<>

Event types sent to this endpoint.

disabled_at*|

Set when the endpoint was disabled, by you or after ten failed deliveries in a row.

Formatdate-time
created_at*string

ISO 8601 with a UTC offset.

Formatdate-time
Example Request
curl -X PATCH 'https://api.whocoming.com/v1/webhook-endpoints/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "mode": "live",  "url": "string",  "events": [    "rsvp.created"  ],  "disabled_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}