Skip to main content
GET
/
webhook
Get all webhooks of a company
curl --request GET \
  --url https://api.clickpay.app.br/webhook \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "67b14aa9-daac-800e-83bf-f1b44468d1d9",
    "url": "https://example.com/webhook",
    "name": "Payment Webhook",
    "companyId": "67b14aa9-daac-800e-83bf-f1b44468d1d9",
    "status": "ACTIVE",
    "events": [
      "order_created",
      "order_paid"
    ],
    "createdAt": "2024-02-15T12:34:56Z",
    "updatedAt": "2024-02-16T12:34:56Z"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Response

200 - application/json

All webhooks of a company

​
id
string
required

Webhook id

Example:

"67b14aa9-daac-800e-83bf-f1b44468d1d9"

​
url
string
required

Webhook URL

Example:

"https://example.com/webhook"

​
name
string
required

Webhook name

Example:

"Payment Webhook"

​
companyId
string
required

Company id

Example:

"67b14aa9-daac-800e-83bf-f1b44468d1d9"

​
status
string
required

Webhook status

Example:

"ACTIVE"

​
events
enum<string>[]
required

List of subscribed events

Available options:
charge.pending,
charge.processing,
charge.paid,
charge.received,
charge.expired
Example:
["order_created", "order_paid"]
​
createdAt
string<date-time>
required

Creation date

Example:

"2024-02-15T12:34:56Z"

​
updatedAt
string<date-time>
required

Update date

Example:

"2024-02-16T12:34:56Z"