> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar Webhooks
> Lista webhooks da sua conta com suporte a filtros, busca e paginação
#### Escopo
```bash theme={null}
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"
* `status` - [Status do webhook](#response-results-status) (active, disabled, waiting\_config)
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](https://en.wikipedia.org/wiki/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)
## OpenAPI
````yaml GET /public_api/webhook/
openapi: 3.0.3
info:
title: Cakto API
version: 1.0.0
description: Documentação da API pública do Cakto.
servers:
- url: https://api.cakto.com.br
description: Cakto API
security: []
paths:
/public_api/webhook/:
get:
tags:
- webhook
description: |-
API for managing webhook Apps, it inherits from AppPlatformAPI,
customizes the schema generation and filters by webhook platform.
operationId: webhook_list
parameters:
- name: limit
required: false
in: query
description: Número de resultados a serem retornados por página.
schema:
type: integer
- name: page
required: false
in: query
description: Número da página a ser retornada.
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAppSerializerReadList'
examples:
Successo:
value:
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
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'
description: Corpo da resposta status 200
'401':
description: Request não autenticado devido à ausência ou invalidez do token.
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedError'
examples:
Token ausente ou inválido:
$ref: '#/components/examples/UnauthenticatedErrorExample'
security:
- OAuth Token: []
components:
schemas:
PaginatedAppSerializerReadList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/AppSerializerRead'
UnauthenticatedError:
type: object
properties:
detail:
type: string
AppSerializerRead:
type: object
properties:
id:
type: integer
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/AppStatus'
description: |-
Status atual do app
* `active` - Ativo
* `disabled` - Desativado
* `waiting_config` - Aguardando Configuração
* `paused` - Pausado
name:
type: string
title: Nome
description: Nome do app
maxLength: 255
url:
type: string
format: uri
nullable: true
description: URL de destino, onde os eventos serão enviados
maxLength: 2048
products:
type: array
items:
$ref: '#/components/schemas/Product'
readOnly: true
description: Produtos que utilizam este app
events:
type: array
items:
$ref: '#/components/schemas/Event'
readOnly: true
description: Eventos que disparam este app
fields:
title: Campos adicionais
description: Campos adicionais para o app
createdAt:
type: string
format: date-time
readOnly: true
title: Data de criação
description: Data e hora de criação
updatedAt:
type: string
format: date-time
readOnly: true
title: Data de atualização
description: Data e hora da última atualização
processing_events_count:
type: string
readOnly: true
avg_latency:
type: string
readOnly: true
success_rate:
type: string
readOnly: true
required:
- avg_latency
- createdAt
- events
- id
- name
- processing_events_count
- products
- success_rate
- updatedAt
AppStatus:
enum:
- active
- disabled
- waiting_config
- paused
type: string
description: |-
* `active` - Ativo
* `disabled` - Desativado
* `waiting_config` - Aguardando Configuração
* `paused` - Pausado
Product:
type: object
properties:
id:
type: string
description: Identificador único do produto
maxLength: 255
name:
type: string
title: Nome
description: Nome do produto
maxLength: 255
image:
type: string
format: uri
readOnly: true
nullable: true
title: Imagem
description: Imagem do produto
description:
type: string
title: Descrição
description: Descrição do produto
price:
type: number
format: double
description: Preço do produto
currency:
allOf:
- $ref: '#/components/schemas/CurrencyEnum'
title: Moeda
description: |-
Moeda do produto
* `BRL` - Real
* `EUR` - Euro
* `MXN` - Peso Mexicano
* `PEN` - Sol Peruano
* `USD` - Dólar
* `CLP` - Peso Chileno
* `COP` - Peso Colombiano
* `ARS` - Peso Argentino
* `BOB` - Boliviano
* `UYU` - Peso Uruguayo
type:
allOf:
- $ref: '#/components/schemas/ProductType'
title: Tipo
description: |-
Tipo de venda do produto, ex.: venda única, assinatura...
* `unique` - Pagamento único
* `subscription` - Assinatura recorrente
contentDeliveries:
type: array
items:
type: string
readOnly: true
description: Id dos métodos de entrega de conteúdo disponíveis
emailAccessLink:
type: string
format: uri
nullable: true
title: Link de acesso
description: Link a ser enviado por e-mail para acesso ao conteúdo após a compra
maxLength: 2048
salesPage:
type: string
format: uri
nullable: true
title: Página de vendas
description: Link da página de vendas do produto
maxLength: 2048
status:
allOf:
- $ref: '#/components/schemas/ProductStatus'
description: |-
Status atual do produto
* `active` - Ativo
* `waiting_config` - Aguardando Configuração
* `blocked` - Bloqueado
* `deleted` - Deletado
paymentMethods:
type: array
items:
type: string
readOnly: true
description: Id dos métodos de pagamento disponíveis
category:
allOf:
- $ref: '#/components/schemas/Category'
readOnly: true
description: Categoria do produto
required:
- category
- contentDeliveries
- description
- image
- name
- paymentMethods
- price
Event:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
title: Nome do evento
description: Nome descritivo do evento
maxLength: 255
custom_id:
allOf:
- $ref: '#/components/schemas/EventType'
title: ID do evento
description: |-
ID único do evento
* `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
* `subscription_paused` - Assinatura pausada
* `subscription_resumed` - Assinatura reativada
required:
- custom_id
- id
- name
CurrencyEnum:
enum:
- BRL
- EUR
- MXN
- PEN
- USD
- CLP
- COP
- ARS
- BOB
- UYU
type: string
description: |-
* `BRL` - Real
* `EUR` - Euro
* `MXN` - Peso Mexicano
* `PEN` - Sol Peruano
* `USD` - Dólar
* `CLP` - Peso Chileno
* `COP` - Peso Colombiano
* `ARS` - Peso Argentino
* `BOB` - Boliviano
* `UYU` - Peso Uruguayo
ProductType:
enum:
- unique
- subscription
type: string
description: |-
* `unique` - Pagamento único
* `subscription` - Assinatura recorrente
ProductStatus:
enum:
- active
- waiting_config
- blocked
- deleted
type: string
description: |-
* `active` - Ativo
* `waiting_config` - Aguardando Configuração
* `blocked` - Bloqueado
* `deleted` - Deletado
Category:
type: object
properties:
id:
type: string
maxLength: 255
name:
type: string
maxLength: 255
required:
- name
EventType:
enum:
- 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
- subscription_paused
- subscription_resumed
type: string
description: |-
* `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
* `subscription_paused` - Assinatura pausada
* `subscription_resumed` - Assinatura reativada
examples:
UnauthenticatedErrorExample:
summary: Token ausente ou inválido
description: Token ausente ou inválido
value:
detail: As credenciais de autenticação não foram fornecidas.
securitySchemes:
OAuth Token:
type: http
scheme: bearer
in: header
name: Authorization
description: >-
Token de autenticação do tipo `Bearer {access_token}`, onde
`{access_token}` é o token obtido no fluxo de
[autenticação](/authentication).
````