POpostproxy
Webhooks

Get webhook

Retrieves a single webhook. The secret field is only included when fetching a single webhook or immediately after creation.

get/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.

Response

The 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.