webhooks

Update a webhook

Change a webhook's URL or events, or turn it off or on.

  • Only its creator can change it; another member's is forbidden.
  • A webhook turns itself off when its receiver answers 410 or fails 20 deliveries in a row. Setting status to active turns it back on and clears its failures.
patch/v1/webhooks/{id}

Request

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

Path parameters

idstring required
Example:wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a webhook ID: wh_ and 32 lowercase hex digits

Request body

urlstring
eventsstring[]

an array of at least 1 item(s)

status'active' | 'disabled'

active turns a disabled webhook on again and clears its failures; disabled turns it off

Response

The changed webhook

idstring required

a webhook ID: wh_ and 32 lowercase hex digits

urlstring required
eventsstring[] required
status'active' | 'disabled' required
disabled_reason'manual' | 'gone' | 'unreachable' | 'secret_unreadable' nullable required

Why a disabled webhook sends nothing: manual (turned off), gone (its receiver answered 410), unreachable (20 failed deliveries in a row) or secret_unreadable (rotate its secret)

created_atstring required

a string to be decoded into a Date

last_delivery_atstring required

a string to be decoded into a Date

Example response

{
  "id": "wh_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
}

Changes

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