API docs by Redocly

PLATFORM RC-91 — Webhooks Subscription Management Runtime (v1) (rc91)

Download OpenAPI specification:

Contract-only OpenAPI for subscription management operations used by the RC-91 reference runtime.

Create a webhook subscription

Request Body schema: application/json
required
merchant_id
required
string
target_url
required
string
event_types
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "merchant_id": "string",
  • "target_url": "string",
  • "event_types": [
    ]
}

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "merchant_id": "string",
  • "status": "enabled",
  • "target_url": "string",
  • "event_types": [
    ],
  • "signing": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List webhook subscriptions

query Parameters
limit
integer [ 1 .. 200 ]
Default: 50
cursor
string

Responses

Response samples

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

Get a webhook subscription

path Parameters
subscription_id
required
string

Responses

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "merchant_id": "string",
  • "status": "enabled",
  • "target_url": "string",
  • "event_types": [
    ],
  • "signing": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Rotate webhook signing secret (active + previous window)

path Parameters
subscription_id
required
string

Responses

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "key_id_active": "string",
  • "key_id_previous": "string",
  • "rotation_deadline_at": "2019-08-24T14:15:22Z",
  • "subscription": {
    }
}

Disable webhook subscription

path Parameters
subscription_id
required
string

Responses

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "merchant_id": "string",
  • "status": "enabled",
  • "target_url": "string",
  • "event_types": [
    ],
  • "signing": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Enable webhook subscription

path Parameters
subscription_id
required
string

Responses

Response samples

Content type
application/json
{
  • "subscription_id": "string",
  • "merchant_id": "string",
  • "status": "enabled",
  • "target_url": "string",
  • "event_types": [
    ],
  • "signing": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}