Skip to main content
PATCH
Atualizar a webhook object

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

webhook_id
integer
obrigatório

O ID numérico do webhook

Corpo

application/json
url
string

A url para onde os eventos devem ser enviados

Exemplo:

"https://example.com/webhook"

name
string

O nome do webhook

subscriptions
enum<string>[]

Os eventos que você deseja assinar.

Opções disponíveis:
conversation_created,
conversation_status_changed,
conversation_updated,
message_created,
message_updated,
contact_created,
contact_updated,
webwidget_triggered
Exemplo:

Resposta

Sucesso

id
number

O ID do webhook

url
string

O URL para o qual os eventos serão enviados

name
string

O nome do webhook

subscriptions
enum<string>[]

A lista de eventos inscritos

Opções disponíveis:
conversation_created,
conversation_status_changed,
conversation_updated,
contact_created,
contact_updated,
message_created,
message_updated,
webwidget_triggered
account_id
number

O id da conta ao qual o objeto webhook pertence