webhooks

Change a webhook endpoint

Change where an endpoint points, what it is sent, what it is called, or whether it is on. A new URL is fenced exactly as a new registration is. Setting status back to active clears the failure streak — leaving it at 20 would switch the endpoint off again on its next failure, whatever was fixed. The signing secret does not change and is not returned; to change it, delete the endpoint and register another.

patch/webhooks/{id}

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/webhooks/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

descriptionstring nullable
eventsstring[]
status'active' | 'disabled'

disabled stops delivery and marks every pending delivery failed; active turns it back on and clears the streak.

urlstring

Response

Change a webhook endpoint

Changes

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