v1

latestOpenAPI 3.1.02026-07-2420077.8 KB

Update a webhook endpoint

Updates the webhook endpoint. You may edit the url, the list of events, status, secret or name. The target url of the webhook must be unique for the account, if the target url is not unique a client error HTTP 409 will be returned.

patch/webhooks/{id}

Path parameters

idinteger required

Unique identifier for the webhook.

Response

200

idstring

namestring

urlstring

secretstring

statusstring

eventsstring[]

Example response

{
  "id": "b42820bb-24c9-48da-bded-487681e9c851",
  "name": "invoice webhook",
  "url": "https://mycompany.com/tk_webhook",
  "secret": "some secret",
  "status": "enabled",
  "events": [
    "invoice.issued"
  ]
}