Webhooks

Update a webhook

Change the url, query or active flag without losing your place in the stream. Delete-and-recreate would reset the subscription to start from now, so anything that appeared in the gap would never be delivered.

The delivery position is preserved even when you widen the query: a subscription's position is a point in time, not a set of rows. Re-activating a parked webhook clears its failure count.

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.omniaauto.ca
  • URL: https://api.omniaauto.ca/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

urlstring uri
queryobject
activeboolean

Example request

{
  "url": "https://example.com/hooks/omnia-v2",
  "active": true
}

Response

Updated

Changes

No recorded changes to this operation across all 1 revision of this API.