API docs by Redocly

Platform Webhooks Subscriptions API (RC-80, v1.2) (1.2)

Download OpenAPI specification:

PLANNING ONLY: contract-only API specification.

Event catalog source of truth (referenced, not duplicated): docs/contracts/v1/webhooks/rc79/event_catalog_v1_1.md

Create a webhook subscription

header Parameters
Idempotency-Key
required
string
Request Body schema: application/json
required
merchant_id
required
string
endpoint_url
required
string
event_types
required
Array of strings non-empty

Responses

Request samples

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

Response samples

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

List webhook subscriptions

Responses

Response samples

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

Get a webhook subscription

path Parameters
subscription_id
required
string

Responses

Response samples

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

Update a webhook subscription

path Parameters
subscription_id
required
string
header Parameters
Idempotency-Key
required
string
Request Body schema: application/json
required
endpoint_url
string
event_types
Array of strings non-empty

Responses

Request samples

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

Response samples

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

Disable (terminal) a webhook subscription

path Parameters
subscription_id
required
string
header Parameters
Idempotency-Key
required
string

Responses

Response samples

Content type
application/json
{
  • "error_code": "invalid_url",
  • "message": "string",
  • "request_id": "string"
}

Pause a webhook subscription

path Parameters
subscription_id
required
string

Responses

Response samples

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

Resume a webhook subscription

path Parameters
subscription_id
required
string

Responses

Response samples

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