Skip to main content
POST
Criar um webhook
A criação dos webhooks é restrita ao limite definido ao plano da sua loja, acesse a página de planos para consultar seu limite. Webhooks criados por aplicativos homologados não são levados em consideração nessa contagem.

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Representa os dados necessários para criar ou atualizar um webhook

url
string<uri>
required

URL para onde os eventos serão enviados

Example:

"https://suaurl.com/api/webhooks"

events
string[]
required

Lista de eventos para os quais o webhook será acionado

Example:
name
string
required

Nome do webhook

Example:

"Nome do webhook"

Response

Webhook criado com sucesso

Recursos adicionais do webhook, retornados sob demanda via parâmetro include.

id
integer

ID do webhook.

active
boolean

Indica se o webhook está ativo e recebendo os eventos assinados.

name
string

Nome do webhook

Example:

"Webhook de integração com CRM"

url
string<uri>

URL para onde os eventos serão enviados

Example:

"https://suaurl.com/api/webhooks"

secret_key
string

Chave secreta de 40 caracteres usada para gerar a assinatura HMAC enviada nas requisições do webhook, permitindo validar a origem do evento.

events
object

Eventos assinados pelo webhook.

products
object

Produtos aos quais o webhook está restrito.

disabled_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

created_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

updated_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.