Webhooks

Server

List webhook subscriptions

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions

List webhook subscriptions › Responses

200

Webhook subscriptions.

No data returned

Create webhook subscription

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions

Create webhook subscription › Request Body

WebhookSubscriptionRequest

url

string · uri · required

eventTypes

string[] · required

secret

string

Create webhook subscription › Responses

Subscription created.

No data returned

Delete webhook subscription

DELETE

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions/{id}

Delete webhook subscription › path Parameters

id

string · uuid · required

Delete webhook subscription › Responses

Deleted.

No data returned

Update webhook subscription

PATCH

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions/{id}

Update webhook subscription › path Parameters

id

string · uuid · required

Update webhook subscription › Responses

200

Updated.

No data returned

List webhook deliveries

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/deliveries

List webhook deliveries › Responses

200

Delivery attempts.

No data returned

Replay webhook delivery

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/deliveries/{id}/replay

Replay webhook delivery › path Parameters

id

string · uuid · required

Replay webhook delivery › Responses

Replay queued.

No data returned

Plane B Observability

HeritagePay API

Webhooks

Server

List webhook subscriptions

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions

List webhook subscriptions › Responses

200

Webhook subscriptions.

No data returned

Create webhook subscription

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions

Create webhook subscription › Request Body

WebhookSubscriptionRequest

url

string · uri · required

eventTypes

string[] · required

secret

string

Create webhook subscription › Responses

Subscription created.

No data returned

Delete webhook subscription

DELETE

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions/{id}

Delete webhook subscription › path Parameters

id

string · uuid · required

Delete webhook subscription › Responses

Deleted.

No data returned

Update webhook subscription

PATCH

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/subscriptions/{id}

Update webhook subscription › path Parameters

id

string · uuid · required

Update webhook subscription › Responses

200

Updated.

No data returned

List webhook deliveries

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/deliveries

List webhook deliveries › Responses

200

Delivery attempts.

No data returned

Replay webhook delivery

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/internal/webhooks/deliveries/{id}/replay

Replay webhook delivery › path Parameters

id

string · uuid · required

Replay webhook delivery › Responses

Replay queued.

No data returned

Plane B Observability