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

Representa um webhook

id
integer
active
boolean
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
events
object
products
object
disabled_at
object
created_at
object
updated_at
object