API docs by Redocly

Platform Webhooks API (RC-81 v1.3) (v1.3)

Download OpenAPI specification:

Contract-only (PLANNING-ONLY) OpenAPI for webhooks delivery logs + replay request.

List webhook delivery logs (metadata only)

query Parameters
subscription_id
string
event_id
string
event_type
string
status
string (WebhookDeliveryStatus)
Enum: "PENDING" "SUCCESS" "FAILED" "ABANDONED"
from_time
string <date-time>
to_time
string <date-time>
limit
integer <= 200
Default: 50
cursor
string

Responses

Response samples

Content type
application/json
{
  • "deliveries": [
    ],
  • "next_cursor": "string"
}

Get webhook delivery log detail (metadata only)

path Parameters
delivery_id
required
string

Responses

Response samples

Content type
application/json
{
  • "delivery_id": "string",
  • "merchant_id": "string",
  • "subscription_id": "string",
  • "event_type": "string",
  • "event_id": "string",
  • "attempt_number": 1,
  • "status": "PENDING",
  • "http_status": 0,
  • "request_id": "string",
  • "sent_at": "2019-08-24T14:15:22Z",
  • "response_at": "2019-08-24T14:15:22Z",
  • "next_retry_at": "2019-08-24T14:15:22Z",
  • "last_error_code": "string",
  • "last_error_message": "string",
  • "payload_hash": "string",
  • "signature_version": "v1",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Request webhook replay (ack only; no runtime guarantee in RC-81)

header Parameters
Idempotency-Key
required
string
Request Body schema: application/json
required
merchant_id
required
string
subscription_id
string
event_id
string
event_type
string

MUST be in docs/contracts/v1/webhooks/rc79/event_catalog_v1_1.md

from_time
string <date-time>
to_time
string <date-time>
reason
required
string <= 200 characters

Responses

Request samples

Content type
application/json
{
  • "merchant_id": "string",
  • "subscription_id": "string",
  • "event_id": "string",
  • "event_type": "string",
  • "from_time": "2019-08-24T14:15:22Z",
  • "to_time": "2019-08-24T14:15:22Z",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "replay_request_id": "string"
}