Skip to main content
POST
/
public_api
/
webhook
cURL
curl --request POST \
  --url https://api.cakto.com.br/public_api/webhook/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "products": [
    "<string>"
  ],
  "events": [
    "initiate_checkout"
  ],
  "status": "active"
}
'
{
  "id": 2863878,
  "status": "active",
  "name": "Venda Aprovada <Produto 1>",
  "url": "https://destination-url-example.com.br/webhook-endpoint",
  "products": [
    {
      "id": "cd287b31-d4b7-4e94-858a-96e05ce2f4r4",
      "name": "Produto 1",
      "image": "https://image-url-example.com.br",
      "description": "Produto 1",
      "price": 5,
      "type": "unique",
      "contentDeliveries": [
        "cakto",
        "telegram",
        "discord"
      ],
      "emailAccessLink": null,
      "salesPage": "https://pv.example.com.br/product/",
      "status": "active",
      "paymentMethods": [
        "boleto",
        "credit_card",
        "picpay"
      ],
      "category": {
        "id": "0673d296-1802-45e0-bc93-612f7514dddb",
        "name": "Apps & Software"
      }
    }
  ],
  "events": [
    {
      "id": 3,
      "name": "Compra aprovada",
      "custom_id": "purchase_approved"
    }
  ],
  "fields": {
    "secret": "8a67e42d-08b9-4987-9f40-0fe7bfd15a5a"
  },
  "createdAt": "2050-11-07T09:11:58.377388-03:00",
  "updatedAt": "2050-11-07T09:11:58.377406-03:00"
}

​
Escopo

    write webhooks
Ao criar um webhook, você pode selecionar múltiplos eventos.
  • Certifique-se de que sua URL está preparada para receber requisições POST com conteúdo JSON.
  • Sua aplicação deve responder em até 5 segundos para evitar falhas de entrega.

Authorizations

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Body

​
name
string
required

Nome do app

Maximum string length: 255
​
url
string<uri> | null
required

URL de destino, onde os eventos serão enviados

Maximum string length: 2048
​
products
string[]
required

Produtos que utilizam este app

​
events
enum<string>[]
required

custom_id de eventos para associar ao app webhook

  • initiate_checkout - Inicio de Checkout
  • checkout_abandonment - Abandono de Checkout
  • purchase_approved - Compra aprovada
  • purchase_refused - Compra recusada
  • pix_gerado - Pix gerado
  • boleto_gerado - Boleto gerado
  • picpay_gerado - PicPay gerado
  • openfinance_nubank_gerado - Nubank gerado
  • chargeback - Chargeback
  • refund - Reembolso
  • subscription_created - Assinatura criada
  • subscription_canceled - Assinatura cancelada
  • subscription_renewed - Assinatura renovada
  • subscription_renewal_refused - Renovação de assinatura recusada
Available options:
initiate_checkout,
checkout_abandonment,
purchase_approved,
purchase_refused,
pix_gerado,
boleto_gerado,
picpay_gerado,
openfinance_nubank_gerado,
chargeback,
refund,
subscription_created,
subscription_canceled,
subscription_renewed,
subscription_renewal_refused
​
status
enum<string>

Status atual do app

  • active - Ativo
  • disabled - Desativado
  • waiting_config - Aguardando Configuração
Available options:
active,
disabled,
waiting_config

Response

Corpo da resposta status 200

​
id
integer
required
​
name
string
required

Nome do app

Maximum string length: 255
​
products
object[]
required

Produtos que utilizam este app

​
events
object[]
required

Eventos que disparam este app

​
createdAt
string<date-time>
required

Data e hora de criação

​
updatedAt
string<date-time>
required

Data e hora da última atualização

​
status
enum<string>

Status atual do app

  • active - Ativo
  • disabled - Desativado
  • waiting_config - Aguardando Configuração
Available options:
active,
disabled,
waiting_config
​
url
string<uri> | null

URL de destino, onde os eventos serão enviados

Maximum string length: 2048
​
fields
any

Campos adicionais para o app