POpostproxy
Webhooks

Update webhook

Updates a webhook's URL, subscribed events, enabled state, or description.

patch/api/webhooks/{id}

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Webhook id

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Headers

Idempotency-Keystring

Optional idempotency key (up to 255 characters; a UUID is ideal). Retrying a successful write with the same key replays the original response (with an Idempotent-Replay: true header) instead of executing again. Stored responses are kept for 24 hours; only 2xx responses are stored.

Request body

urlstring

New HTTPS URL.

eventsstring[]

New event types.

enabledboolean

Enable or disable the webhook.

descriptionstring

Updated description.

Response

The updated webhook

idstring

Webhook id.

urlstring

HTTPS URL that receives webhook events.

eventsstring[]

Subscribed event types (["*"] means all events).

enabledboolean

Whether the webhook is enabled.

descriptionstring

Description for the webhook.

secretstring

Signing secret used to verify webhook signatures. Only included when fetching a single webhook or immediately after creation.

created_atstring

ISO 8601 creation time.

updated_atstring

ISO 8601 last update time.

Changes

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