Get a webhook endpoint

GET /api/v1/webhooks/endpoints/{endpoint_id}

Get a webhook endpoint

cURL

curl --request GET \
  --url https://api.example.com/api/v1/webhooks/endpoints/{endpoint_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "disabled": true,
  "event_types": [
    "<string>"
  ],
  "headers": [
    {
      "name": "<string>",
      "sensitive": true,
      "set": true,
      "value": "<string>"
    }
  ],
  "id": "whe_7n42DGM5Tflk9n8mt7Fhc7",
  "max_in_flight": 123,
  "needs_setup": true,
  "url": "<string>",
  "description": "<string>",
  "disabled_reason": "MANUAL",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "last_success_at": "2023-11-07T05:31:56Z",
  "paused_until": "2023-11-07T05:31:56Z",
  "rate_limit_per_sec": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

endpoint_id · string<MeteroidId> · required

Webhook endpoint ID

Example:

"whe_7n42DGM5Tflk9n8mt7Fhc7"

Response

200

application/json

Webhook endpoint

A destination Meteroid POSTs signed event payloads to.

consecutive_failures · integer<int32> · required

Failures since the last success, reset to 0 on any 2xx.

created_at · string<date-time> · required

disabled · boolean · required

event_types · string[] · required

Subscribed event types. Empty means every event type.

headers · object[] · required

Custom headers sent with every delivery.

Show child attributes

id · string<MeteroidId> · required

Example:

"whe_7n42DGM5Tflk9n8mt7Fhc7"

max_in_flight · integer<int32> · required

How many deliveries this endpoint may have in flight at once. Read-only; it is set from the tenant's environment when the endpoint is created.

needs_setup · boolean · required

A sensitive header still waits for its value; the endpoint cannot be enabled until it is set.

url · string · required

description · string | null

disabled_reason · enum<string> | null

Available options: MANUAL, AUTO_FAILURES, GONE

last_failure_at · string<date-time> | null

last_success_at · string<date-time> | null

paused_until · string<date-time> | null

The endpoint was unreachable several times in a row: nothing is sent before this time, then it is retried one delivery at a time until it answers again.

rate_limit_per_sec · integer<int32> | null

Deliveries started per second, at most.

updated_at · string<date-time> | null