v1

latestOpenAPI 3.0.02026-07-263118119.8 KB
Webhooks

createWebhookSigningKey

Create a webhook.

Specify a topic and a url. Use this call to either create or update a webhook for a topic.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP009401Unauthorized
AP101401No authenticated user
AP1000200Invalid API
AP1107400Merchant is required
</details>
post/v2/createWebhookSigningKey

Headers

Content-Typestring required
authorizationstring required

A merchant scoped token.

Request body

topicstring

The event topic to subscribe to.

urlstring

The destination URL where webhooks will be sent.

Example request

{
  "topic": "transaction_completed",
  "url": "https://webhook.site/9374cfe2-8535-44ec-86d6-20e949fd7919"
}

Response

Successful Response - Signing Key Created

messagestring
signingKeystring