Update a webhook endpoint

PATCHhttps://api-staging.pixwel.com/api/webhook-endpoints/{id}

Path parameters

idstringrequired

Body

urlstring<uri>

enabledEventsany[]

descriptionstringnull

statusenabled · disabled

Response

_idstringrequired

urlstring,null<uri>required

HTTPS destination for HTTP endpoints; null for CLI endpoints.

transporthttp · clirequired

descriptionstringnullrequired

enabledEventsany[]required

`["*"]` subscribes to every public event.

apiVersionstringrequired

curl -X PATCH 'https://api-staging.pixwel.com/api/webhook-endpoints/{id}' \
  -H 'Authorization: Basic <credentials>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com",
  "enabledEvents": [
    null
  ],
  "description": null,
  "status": "enabled"
}'

{
  "_id": "string",
  "url": null,
  "transport": "http",
  "description": null,
  "enabledEvents": [
    null
  ],
  "apiVersion": "string",
  "status": "enabled",
  "createdAt": 0,
  "lastSuccessAt": null,
  "lastFailureAt": null
}