cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/webhook/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/webhook/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/webhook/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cakto.com.br/public_api/webhook/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/webhook/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/webhook/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/webhook/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"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"
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Webhooks
Listar Webhooks
Lista webhooks da sua conta com suporte a filtros, busca e paginação
GET
/
public_api
/
webhook
/
cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/webhook/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/webhook/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/webhook/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cakto.com.br/public_api/webhook/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/webhook/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/webhook/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/webhook/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"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"
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}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.Filtros por Identificação
Filtros por Identificação
name- Nome do webhook (busca parcial case-insensitive)url- URL do webhook (busca parcial case-insensitive)
?name=Aprovado - Filtra webhooks cujo nome contém “Aprovado”Filtros por Status
Filtros por Status
status- Status do webhook (active, disabled, waiting_config)
Suporte a múltiplos valores separados por vírgula.
?status=active,disabled - Filtra webhooks ativos ou desativadosFiltros por Eventos
Filtros por Eventos
events- IDs customizados dos eventos (múltiplos valores separados por vírgula)
Suporte a múltiplos valores separados por vírgula.
?events=purchase_approved,checkout_abandonment - Filtra webhooks que escutam os eventos de Compra Aprovada ou Abandono de CheckoutFiltros por Datas
Filtros por Datas
createdAt- Data de criaçãoupdatedAt- 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?createdAt__gte=2024-01-01&createdAt__lt=2024-02-01T23:59:59Z - Filtra produtos criados em janeiro de 2024Filtros por Relacionamentos
Filtros por Relacionamentos
products- IDs dos produtos (múltiplos valores suportados)
Filtra webhooks associados aos produtos especificados.
?products=123,456 - Filtra webhooks associados aos produtos 123 ou 456Busca
O endpoint suporta busca textual pelo parâmetrosearch nos seguintes campos:
name- Nome da integração webhookurl- URL da integração webhook
?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âmetroordering.
Campos suportados: status, name, url, createdAt, updatedAt
Use o prefixo
- para ordenação decrescente.?ordering=-createdAt - Ordena por data de criação (mais recentes primeiro)Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Query Parameters
Número de resultados a serem retornados por página.
Número da página a ser retornada.
Was this page helpful?