Pular para o conteúdo

GET /v1/webhooks/endpoints

GET
/v1/webhooks/endpoints
curl --request GET \
--url https://seu-endereco-da-api/v1/webhooks/endpoints \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Gerenciar canais (channels:manage).

Media typeapplication/json
object
items
required
Array<object>
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

{
"items": [
{
"state": "ativo",
"pausedReason": "failures"
}
]
}