Criar um webhook

Cria uma assinatura de webhook na conta que a sua integração está vinculada. Os webhooks criados não serão listados na tela do RD Station Marketing.

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

Requisitos para criação do Webhook

  • Ao criar uma nova assinatura, o endpoint executa uma validação inicial. A solicitação deve retornar um status 2xx para ser considerada bem-sucedida. Caso a validação falhe, o endpoint retorna 401 Unauthorized, e a assinatura não será criada.
  • Não é permitido o cadastro de URLs duplicadas para o mesmo event_type. Nesses casos, deve-se atualizar a assinatura já existente informando o event_type desejado. Para modificar uma assinatura já criada, utilize o endpoint em Atualizar um Webhook.
Body Params
string
enum
required

O tipo de evento que aciona a solicitação de webhook. Atualmente somente eventos de negociação, conversão e oportunidade são suportados

Allowed:
string
enum
required

A entidade da assinatura do webhook. Por enquanto, 'CONTATO' é a única opção aceita

Allowed:
event_identifiers
array of strings

Os identificadores dos eventos que devem acionar o webhook. Apenas para eventos 'WEBHOOK.CONVERTED'

event_identifiers
string
required

A URL de destino do webhook

string
enum
required

O método http que o webhook acionará. Atualmente, apenas o método 'POST' é suportado

Allowed:
include_relations
array of strings

Quais itens adicionais serão fornecidos no payload do webhook. Apenas 'COMPANY' e 'CONTACT_FUNNEL' são opções válidas

include_relations
Responses

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