Get webhooks

GET

/webhook/{name}

• Production
• Sandbox

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

• siweAuth

Parameters

Path Parameters

name

string

/^[a-z0-9-]{1,64}$/

Responses

200

Webhook information

Media typeapplication/json

Any of:

object

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

object

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

Example^generated

{
  "additionalProperty": {
    "url": "https://example.com",
    "transaction": {
      "created": "https://example.com",
      "updated": "https://example.com",
      "completed": "https://example.com"
    },
    "card": {
      "updated": "https://example.com"
    },
    "user": {
      "updated": "https://example.com"
    }
  }
}

400

Invalid webhook name

Media typeapplication/json

object

code

required

Allowed values: invalid name

message

Array<string>

Example

{
  "code": "invalid name"
}

401

Unauthorized

Media typeapplication/json

object

code

required

Allowed values: unauthorized

Example

{
  "code": "unauthorized"
}

403

User doesn't belong to the organization

Media typeapplication/json

Any of:

object

object

code

required

Allowed values: no organization

object

object

code

required

Allowed values: no permission

Example

{
  "code": "no organization"
}

404

Webhook not found

Media typeapplication/json

object

code

required

Allowed values: not found

Example

{
  "code": "not found"
}