Webhooks

Através do recurso de webhooks, a plataforma enviará um POST para as URLS cadastradas sempre quando algum evento acontecer. O payload do recurso é enviado com todas as includes disponíveis.

Eventos disponíveis

GET https://api.dooki.com.br/v2/{alias}/webhooks/events

Evento

Descrição

order.created

Pedido criado

order.status.updated

O status de um pedido foi atualizado

order.invoice.created

Nota fiscal de um pedido foi criada

order.invoice.updated

Nota fiscal de um pedido foi atualizada

transaction.payment.refused

O pagamento de uma transação foi negado

cart.reminder

Notificação de carrinho abandonado

customer.created

Cliente criado

customer.address.created

Endereço do cliente criado

Listar webhooks

GET https://api.dooki.com.br/v2/{alias}/webhooks

Criar um webhook

POST https://api.dooki.com.br/v2/{alias}/webhooks

Request para incluir um novo webhook

{
"url": "http://suaurl.com/api/webhooks",
"events": ["order.created", "cart.reminder"],
"name": "Nome do webhook"
}

Response de webhook

{
"data": [
"id": 1,
"url": "http://suaurl.com/api/webhooks"
]
}

Payload enviado pelo webhook

{
"event": "order.created",
"resource": {
// Payload de um pedido
}
}

Parâmetro

Tipo

Obrigatório

Descrição

url

string

Sim

URL que o webhook será enviado.

events

arrays

Sim

Quais eventos serão enviados para o endpoint cadastrado.

name

string

Sim

Nome do webhook.

Atualizar um webhook

PUT https://api.dooki.com.br/v2/{alias}/orders/webhooks/{id}

Excluir um webhook

DELETE https://api.dooki.com.br/v2/{alias}/orders/webhooks/{id}