Criar webhook

Cadastra um endereço https que recebe os eventos escolhidos (events, tipos do catálogo em GET /v1/webhooks/event-types). Um webhook pertence a uma integração e recebe só os eventos dos recursos que essa integração pode ler, pelas mesmas regras de permissão, departamento e visibilidade das conversas de uma leitura pela API. Com uma chave de API, o webhook é da integração da chave; com o login de uma pessoa, informe integrationId, e só quem gerencia os membros do workspace cria webhooks de uma integração. O endereço precisa resolver para um endereço público; privados, locais e de metadados são recusados agora e a cada entrega. O segredo de assinatura (secret, prefixo whsec_) aparece só nesta resposta e na troca de segredo. Até 50 webhooks por workspace. A assinatura, os cabeçalhos e as novas tentativas estão no guia Webhooks. Exige webhooks:create.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Endereço, tipos de evento, integração e se começa ativo (padrão ativo)

boolean
events
array of strings
events
string
string
Headers
string

Chave de idempotência (1 a 255 caracteres ASCII imprimíveis); repetir a chave com o mesmo corpo devolve a mesma resposta

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json