Skip to main content
POST
Register a webhook
Requires scope: manage:webhooks — see Required scopes. Registers a webhook endpoint for your company so Venly can push asynchronous events — pay-in session transitions, pay-out status changes, verification verdicts and settlement outcomes — instead of you polling for them. The url must be an absolute https:// endpoint. Pick an authenticationMethod so your endpoint can verify the caller:
Secrets (apiKey, password) are write-only. They are accepted here and never echoed back on any read response, so store your own copy — to change one, send a full update.
After registering, send a ping to validate your endpoint end-to-end.

Authorizations

Body

application/json

Registers a webhook endpoint for your company.

url
string<uri>
required

Absolute https:// endpoint the webhook delivers to

Maximum string length: 2048
Example:

"https://client.example/hooks/venly"

authenticationMethod
object
required

Authentication applied to outbound webhook deliveries, discriminated by type. Secret fields (apiKey, password) are accepted on input and omitted from every read response.

name
string | null

Optional human-readable label

Maximum string length: 255

Response

Webhook registered

success
boolean

Indicates whether the request was successful

result
object

A registered webhook. Authentication secrets are omitted from this representation.