Sign in

v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Subscriptions

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.

post/integrations/webhooks

Request body

event_type'WEBHOOK.CONVERTED' | 'WEBHOOK.MARKED_OPPORTUNITY' | 'crm_deal_created' | 'crm_deal_updated' | 'crm_deal_deleted' 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

entity_type'CONTACT' required

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

event_identifiersstring[]

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

urlstring required

A URL de destino do webhook

http_method'POST' required

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

include_relationsstring[]

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

Example request

{
  "url": "https://webhook-callback-url.com"
}

Response

Created

created_atstring

Data de criação do Webhook

updated_atstring

Data da última atualização do Webhook

event_identifiersstring[]

Permite filtrar os identificadores do evento que aciona o webhook. Apenas para eventos 'WEBHOOK.CONVERTED'

event_typestring

O tipo de evento que aciona a solicitação de webhook

entity_typestring

A entidade da assinatura do webhook

http_methodstring

O método http que o webhook acionará

include_relationsstring[]

Quais itens adicionais serão fornecidos no payload do webhook

platform_account_idnumber

Identificador da conta

sourcestring

Fonte do evento. Temos 2 no momento, MKT ou CRM

statusstring

O status do webhook, cujo valor padrão é 'active'

urlstring

A URL de destino do webhook

uuidstring

O uuid exclusivo associado a cada assinatura de webhook do RD Station

Example response

{
  "created_at": "2023-09-29T01:20:42.826Z",
  "updated_at": "2023-09-30T01:20:42.826Z",
  "event_identifiers": [
    "WEBHOOK.CONVERTED"
  ],
  "event_type": "WEBHOOK.CONVERTED",
  "entity_type": "CONTACT",
  "http_method": "POST",
  "include_relations": [
    "CONTACT_FUNNEL",
    "COMPANY"
  ],
  "platform_account_id": 818000000000436400,
  "source": "MKT",
  "status": "active",
  "url": "http://my-mkt-webhook-url.com",
  "uuid": "ce4cfed6-cc7d-41e3-86e3-00a27380a2df"
}