Skip to main content
GET
/
public_api
/
webhook
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/webhook/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "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

    read webhooks

​
Filtros Disponíveis

Filtros podem ser combinados para refinar ainda mais os resultados.Exemplo: ?status=active&products=123 - Filtra webhooks ativos associados ao produto com Id 123.
  • name - Nome do webhook (busca parcial case-insensitive)
  • url - URL do webhook (busca parcial case-insensitive)
Exemplo: ?name=Aprovado - Filtra webhooks cujo nome contém “Aprovado”
Suporte a múltiplos valores separados por vírgula.
Exemplo: ?status=active,disabled - Filtra webhooks ativos ou desativados
  • events - IDs customizados dos eventos (múltiplos valores separados por vírgula)
Suporte a múltiplos valores separados por vírgula.
Exemplo: ?events=purchase_approved,checkout_abandonment - Filtra webhooks que escutam os eventos de Compra Aprovada ou Abandono de Checkout
  • createdAt - Data de criação
  • updatedAt - Data de última atualização
Suporte a operadores de comparação (__gt, __gte, __lt, __lte)
Formato de data: YYYY-MM-DD ou ISO 8601 YYYY-MM-DDTHH:MM:SS±hh:mm
Exemplo: ?createdAt__gte=2024-01-01&createdAt__lt=2024-02-01T23:59:59Z - Filtra produtos criados em janeiro de 2024
  • products - IDs dos produtos (múltiplos valores suportados)
Filtra webhooks associados aos produtos especificados.
Exemplo: ?products=123,456 - Filtra webhooks associados aos produtos 123 ou 456

​
Busca

O endpoint suporta busca textual pelo parâmetro search nos seguintes campos:
  • name - Nome da integração webhook
  • url - URL da integração webhook
Exemplo: ?search=meu-produto - Busca pelo texto “meu-produto” nos campos de busca. Qualquer webhook onde um dos campos contenha o texto será retornado, (“meu-produto 2.0” e “Oferta B meu-produto” seriam retornadas).

​
Ordenação

Você pode ordenar os resultados usando o parâmetro ordering. Campos suportados: status, name, url, createdAt, updatedAt
Use o prefixo - para ordenação decrescente.
Exemplo: ?ordering=-createdAt - Ordena por data de criação (mais recentes primeiro)

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.

Query Parameters

​
limit
integer

Número de resultados a serem retornados por página.

​
page
integer

Número da página a ser retornada.

Response

Corpo da resposta status 200

​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]