POST
Register webhook

Authorizations

Authorization
string
header
required

API key as Bearer token. Sandbox keys start with sk_test_, mainnet keys with sk_live_.

Body

application/json
url
string<uri>
required
Example:

"https://example.com/webhooks/sohopay"

events
string[]
required
Example:

Response

201 - application/json

Webhook registered. The signing secret is returned once — store it securely.

webhook_id
string
Example:

"whk_8e7d6c5b"

url
string<uri>
Example:

"https://example.com/webhooks/sohopay"

events
string[]
Example:
secret
string

HMAC-SHA256 signing secret. Returned only at creation.

Example:

"whsec_9f8e7d6c5b4a3f2e"

status
enum<string>
Available options:
active,
disabled
Example:

"active"

created_at
string<date-time>