Skip to content
Exa Docs

Get webhooks

GET
/webhook/{name}

Retrieve the organization’s webhook information. Without a name, returns all webhooks as a map keyed by name, or an empty object when the organization has no webhooks configured. With a name, returns the matching webhook, or 404 when the organization has no webhooks configured or no webhook with that name exists. Signing secrets are never returned. Only owner and admin roles can read the webhook information.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
string
/^[a-z0-9-]{1,64}$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Webhook information

Any of:
object
key
additional properties
object
url
required
string format: uri
transaction
object
created
string format: uri
updated
string format: uri
completed
string format: uri
card
object
updated
string format: uri
user
object
updated
string format: uri

400

Section titled “400 ”

Invalid webhook name

object
code
required
Allowed values: invalid name
Example
invalid name
message
Array<string>

401

Section titled “401 ”

Unauthorized

object
code
required
Allowed values: unauthorized
Example
unauthorized

403

Section titled “403 ”

User doesn’t belong to the organization

Any of:
object
code
required
Allowed values: no organization
Example
no organization

404

Section titled “404 ”

Webhook not found

object
code
required
Allowed values: not found
Example
not found