Sign in

v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Subscriptions

Listar um Webhook

Retorna um Webhook criado pela sua integração na conta que ela está vinculado. O webhook criado diretamente pela tela do RD Station Marketing não será listado.

get/integrations/webhooks/{uuid}

Path parameters

uuidstring required
Example:adc6944d-0c74-4e7c-899e-6d816465b561

O UUID exclusivo associado a cada webhook do RD Station.

Response

Success

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

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

entity_typestring

A entidade da assinatura do webhook

uuidstring

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

Example response

{
  "created_at": "2023-09-20T13:51:28.233Z",
  "updated_at": "2023-09-21T13:51:28.233Z",
  "event_identifiers": [
    "WEBHOOK.CONVERTED"
  ],
  "event_type": "WEBHOOK.CONVERTED",
  "http_method": "POST",
  "include_relations": [
    "CONTACT_FUNNEL",
    "COMPANY"
  ],
  "platform_account_id": 818000000000436400,
  "source": "CRM",
  "status": "active",
  "url": "https://webhook-callback-url.com",
  "entity_type": "CONTACT",
  "uuid": "adc6944d-0c74-4e7c-899e-6d816465b561"
}