Saltar para o conteúdo principal
PATCH
/
v1
/
webhooks
/
{id}
Atualizar webhook
curl --request PATCH \
  --url https://api.vendaze.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Nome atualizado do webhook",
  "url": "https://meuapp.com/webhooks/vendaze-v2",
  "events": [
    "person.created",
    "person.updated",
    "deal.won",
    "deal.lost"
  ],
  "auth_enable": false
}
'
{
  "data": {
    "id": "wh_3f9a1c8b2d4e5f6a7b8c9d0e1f2a3b4c",
    "name": "Meu webhook",
    "url": "https://meuapp.com/webhooks/vendaze",
    "events": [
      "person.created",
      "deal.won"
    ],
    "auth_enable": true,
    "webhook_secret": "whsec_3f9a1c8b2d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0",
    "created_at": "2026-05-26T14:00:00.000Z"
  }
}

Autorizações

​
Authorization
string
header
obrigatório

Access token OAuth 2.1.

Parâmetros de caminho

​
id
string
obrigatório

ID do webhook.

Corpo

application/json
​
name
string

Novo nome descritivo.

Required string length: 1 - 100
Exemplo:

"Nome atualizado do webhook"

​
url
string<uri>

Nova URL HTTPS de destino.

Exemplo:

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

​
events
enum<string>[]

Nova lista de eventos monitorados. Substitui a lista existente por completo.

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:
[
  "person.created",
  "person.updated",
  "deal.won",
  "deal.lost"
]
​
auth_enable
boolean

false para true: gera um novo webhook_secret. true para false: deleta permanentemente o webhook_secret existente. Sem alteração: webhook_secret não é modificado.

Exemplo:

false

Resposta

Webhook atualizado com sucesso.

​
data
object