Skip to main content
POST
Criar webhook

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Corpo

application/json
name
string
obrigatório

Nome descritivo do webhook.

Required string length: 1 - 100
Exemplo:

"Meu webhook"

url
string<uri>
obrigatório

URL HTTPS de destino. HTTP não é aceito.

Exemplo:

"https://meuapp.com/webhooks/vendaze"

events
enum<string>[]
obrigatório

Lista de eventos a monitorar.

Minimum array length: 1

Nome de um evento válido para monitorar.

Opções disponíveis:
person.created,
person.updated,
person.deleted,
activity.created,
activity.updated,
activity.deleted,
company.created,
company.updated,
company.deleted,
deal.created,
deal.updated,
deal.stage_changed,
deal.won,
deal.lost,
deal.deleted,
task.created,
task.updated,
task.completed,
task.deleted,
tag.created,
tag.updated,
tag.deleted,
product.created,
product.updated,
product.deleted,
pipeline.created,
pipeline.updated,
pipeline.deleted,
member_invited,
member_joined,
member_removed,
usage_logs.created
Exemplo:
auth_enable
boolean
padrão:false

Ativa entregas assinadas. Quando true, um webhook_secret é gerado e retornado na resposta.

Exemplo:

true

Resposta

Webhook criado com sucesso.

data
object