PATCH /v1/webhooks/endpoints/{id}
PATCH
/v1/webhooks/endpoints/{id}
const url = 'https://seu-endereco-da-api/v1/webhooks/endpoints/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"url":"https://example.com","description":"example","events":["example"],"channelIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"filters":{"pipelineIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"stageIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"tagIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"assigneeIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://seu-endereco-da-api/v1/webhooks/endpoints/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "url": "https://example.com", "description": "example", "events": [ "example" ], "channelIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "filters": { "pipelineIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "stageIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "assigneeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] } }'Permissão que a Chave de acesso precisa: Gerenciar canais (channels:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
url
string format: uri
description
string
events
Array<string>
channelIds
Array<string>
filters
object
pipelineIds
Array<string>
stageIds
Array<string>
tagIds
Array<string>
assigneeIds
Array<string>
Example generated
{ "url": "https://example.com", "description": "example", "events": [ "example" ], "channelIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "filters": { "pipelineIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "stageIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "assigneeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }}Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
url
required
string
description
required
string
state
required
Ativo envia; pausado guarda os eventos até Retomar; desligado não guarda nada
string
pausedAt
required
Desde quando está pausado ou desligado
string format: date-time
pausedReason
required
string
consecutiveFailures
required
number
events
required
Array<string>
allChannels
required
Vale para todos os números da conta (channelIds vazio)
boolean
channelIds
required
Array<string>
filters
required
Entre listas vale E, dentro da lista vale OU
object
pipelineIds
Pipelines; vazio ou ausente é qualquer pipeline
Array<string>
stageIds
Etapas; vazio ou ausente é qualquer etapa
Array<string>
tagIds
Etiquetas do contato; vazio ou ausente é qualquer etiqueta
Array<string>
assigneeIds
Responsáveis da conversa ou do negócio; vazio ou ausente é qualquer um
Array<string>
queued
required
Avisos guardados esperando Retomar
number
createdAt
required
string format: date-time
Example
{ "state": "ativo", "pausedReason": "failures"}