Pular para o conteúdo principal
PATCH
Editar webhook
Os valores aceitos em events estão em Criar webhook.

Resposta

Autorizações

Authorization
string
header
obrigatório

Token de conta gerado no painel da Datafy, em Perfil. Formato: sk_acct_xxx. Diferente do token de canal (sk_live_).

Parâmetros de caminho

id
string
obrigatório

ID do canal, retornado em Listar canais e em Criar canal.

webhookId
string
obrigatório

ID do webhook, retornado em Listar webhooks e em Criar webhook.

Corpo

application/json
url
string

URL que recebe os eventos. Precisa usar HTTPS.

Exemplo:

"https://exemplo.com/webhook"

events
enum<string>[]

Eventos que o webhook recebe. Não pode ser uma lista vazia.

Opções disponíveis:
messages,
smb_message_echoes,
message_template_status_update,
message_template_quality_update,
message_template_components_update,
account_alerts,
account_update,
account_review_update,
account_settings_update,
phone_number_name_update,
phone_number_quality_update,
business_capability_update,
business_status_update,
template_category_update,
template_correct_category_detection,
flows,
calls,
security,
automatic_events,
tracking_events,
history,
smb_app_state_sync,
payment_configuration_update,
partner_solutions,
group_lifecycle_update,
group_participants_update,
group_settings_update,
group_status_update,
user_preferences
Exemplo:
enabled
boolean
padrão:true

Ativa ou desativa o webhook.

Exemplo:

true

Resposta

Webhook editado.

id
string

ID do webhook.

url
string

URL que recebe os eventos.

events
string[]

Eventos que o webhook recebe.

enabled
boolean

Indica se o webhook está ativo.