Pular para o conteúdo

PATCH /v1/webhooks/endpoints/{id}

PATCH
/v1/webhooks/endpoints/{id}
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).

id
required
string
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"
]
}
}
Media typeapplication/json
object
id
required
string
url
required
string
description
required
string
nullable
state
required

Ativo envia; pausado guarda os eventos até Retomar; desligado não guarda nada

string
Allowed values: ativo pausado_por_falhas pausado_por_voce desligado
pausedAt
required

Desde quando está pausado ou desligado

string format: date-time
nullable
pausedReason
required
string
nullable
Allowed values: failures manual no_channels no_filter_targets
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"
}