Pular para o conteúdo principal
POST
/
webhooks
cURL
curl --request POST \
  --url https://public-api.kiwify.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-kiwify-account-id: <api-key>' \
  --data '
{
  "name": "meu webhook",
  "url": "https://webhook.site/73d28a2b-6c48-41e0-a8ad-0d5ef748ce41",
  "products": "all",
  "triggers": [
    "boleto_gerado",
    "pix_gerado",
    "carrinho_abandonado",
    "compra_recusada",
    "compra_aprovada",
    "compra_reembolsada",
    "chargeback",
    "subscription_canceled",
    "subscription_late",
    "subscription_renewed"
  ],
  "token": "w9i3pvutvxe"
}
'
{
  "id": "c2be7f8e-b373-4eb7-b623-16ce98d5ed44",
  "name": "meu webhook",
  "url": "https://webhook.site/73d28a2b-6c48-41e0-a8ad-0d5ef748ce41",
  "products": "ba22c4a0-5c94-11ee-9c2d-8d32d7a17894",
  "triggers": [
    "boleto_gerado",
    "pix_gerado",
    "carrinho_abandonado",
    "compra_recusada",
    "compra_aprovada",
    "compra_reembolsada",
    "chargeback",
    "subscription_canceled",
    "subscription_late",
    "subscription_renewed"
  ],
  "token": "rxue90njjv1",
  "created_at": "2023-11-24T10:06:47.540Z",
  "updated_at": "2023-11-24T10:06:47.540Z"
}

Authorizations

​
x-kiwify-account-id
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
name
string
Example:

"meu webhook"

​
url
string
Example:

"https://webhook.site/73d28a2b-6c48-41e0-a8ad-0d5ef748ce41"

​
products
string
Example:

"all"

​
triggers
enum<string>[]
Opções disponíveis:
boleto_gerado,
pix_gerado,
carrinho_abandonado,
compra_recusada,
compra_aprovada,
compra_reembolsada,
chargeback,
subscription_canceled,
subscription_late,
subscription_renewed
Example:
[
  "boleto_gerado",
  "pix_gerado",
  "carrinho_abandonado",
  "compra_recusada",
  "compra_aprovada",
  "compra_reembolsada",
  "chargeback",
  "subscription_canceled",
  "subscription_late",
  "subscription_renewed"
]
​
token
string
Example:

"w9i3pvutvxe"

Response

Webhook data

​
id
string
Example:

"3d379edc-9e21-47ee-8974-ca80a4c7839d"

​
name
string
Example:

"Meu Webhook"

​
url
string
Example:

"https://webhook.site/73d28a2b-6c48-41e0-a8ad-0d5ef748ce41"

​
products
string
Example:

"all"

​
triggers
enum<string>[]
Opções disponíveis:
boleto_gerado,
pix_gerado,
carrinho_abandonado,
compra_recusada,
compra_aprovada,
compra_reembolsada,
chargeback,
subscription_canceled,
subscription_late,
subscription_renewed
Example:
[
  "boleto_gerado",
  "pix_gerado",
  "carrinho_abandonado",
  "compra_recusada",
  "compra_aprovada",
  "compra_reembolsada",
  "chargeback",
  "subscription_canceled",
  "subscription_late",
  "subscription_renewed"
]
​
token
string
Example:

"rxue90njjv1"

​
created_at
string
Example:

"2023-11-24T10:06:47.540Z"

​
updated_at
string
Example:

"2023-11-24T10:06:47.540Z"