Pular para o conteúdo principal
POST
/
webhook
Create a webhook
curl --request POST \
  --url https://api.cliquepay.app/webhook \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/webhook",
  "webhook": "Nome webhook",
  "events": "Nome webhook"
}'
{
  "id": "67b14aa9-daac-800e-83bf-f1b44468d1d9",
  "url": "https://example.com/webhook",
  "companyId": "67b14aa9-daac-800e-83bf-f1b44468d1d9",
  "createdAt": "2024-02-15T12:34:56Z",
  "updatedAt": "2024-02-16T12:34:56Z"
}

Body

application/json
​
url
string
required

Webhook URL

Example:

"https://example.com/webhook"

​
webhook
string
required

Webhook URL

Example:

"Nome webhook"

​
events
string[]
required

Webhook URL

Example:

"Nome webhook"

Response

201 - application/json

Webhook created

​
id
string
required

Webhook id

Example:

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

​
url
string
required

Webhook URL

Example:

"https://example.com/webhook"

​
companyId
string
required

Company id

Example:

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

​
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"

⌘I