Aller au contenu

List the event types an endpoint can subscribe to.

GET
/v1/webhooks/events
curl --request GET \
--url https://api.asap.cool/v1/webhooks/events \
--header 'Authorization: Bearer <token>'

Subscribable event types.

Media typeapplication/json

Documented event types.

object
events
required

Dotted event tokens (signature.envelope.completed, …).

Array<string>

Example generated

{
"events": [
"example"
]
}

Missing webhooks:read scope.

Media typeapplication/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object
code
required

Stable machine token (e.g. invalid_credentials).

string
field

Offending request field for validation errors, when known.

string | null
message
required

Human-readable message.

string

Example generated

{
"code": "example",
"field": "example",
"message": "example"
}