Get the current configuration and delivery status summary for an Endpoint.
Webhook is currently in Beta. APIs, fields, and behavior may change in future versions.
GET /api/v1/forward/webhook/endpoints/{endpoint_id}
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or administrator SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | Yes | Webhook Endpoint ID. |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Endpoint ID. |
url | string | Event receiver URL. |
description | string | Endpoint description. May be omitted when not set. |
events | string[] | Currently subscribed events. |
metadata | object | Endpoint metadata. |
active | boolean | Whether the Endpoint receives events. |
last_success_at | string/null | Time of the most recent successful delivery, in RFC 3339 format. |
last_failure_at | string/null | Time of the most recent failed delivery, in RFC 3339 format. |
disabled_reason | string | Reason the Endpoint was disabled. Omitted when unavailable. |
consecutive_fail | integer | Number of consecutive delivery failures. |
created_at | string | Creation time, in RFC 3339 format. |
updated_at | string | Update time, in RFC 3339 format. |
signing_secret is not returned by this endpoint.
Errors
| HTTP | Type | Trigger |
|---|---|---|
401 | authentication_error | Authentication is missing, invalid, or expired. |
403 | permission_error | The current token cannot manage Webhooks. |
404 | not_found_error | The Endpoint does not exist or is not visible to the current account. |
500/502/503 | api_error | The service is temporarily unavailable. |