Corpo da requisição
Quando o evento configurado no Webhook é acionado, o RD Station envia uma requisição com o método configurado no http_method com o cabeçalho Content-Type: application/json.
Abaixo seguem os campos disponíveis no payload da requisição:
Payload padrão
{
"event_type": "WEBHOOK.CONVERTED",
"entity_type": "CONTACT",
"event_identifier": "my-event-identifier",
"timestamp": "2018-03-13T14:09:02.724-03:00",
"event_timestamp": "2018-03-13T14:07:04.254-03:00",
"contact": {
"uuid":"c2f3d2b3-7250-4d27-97f4-eef38be32f7f",
"email":"[email protected]",
"name":"Contact Name",
"job_title":"Developer",
"bio":"This is my bio",
"website": "http://rdstation.com.br",
"personal_phone":"48 30252598",
"mobile_phone":"48 30252598",
"city":"Florianópolis",
"facebook": "Contact Facebook",
"linkedin": "Contact Linkedin",
"twitter": "Contact Twitter",
"tags": ["tag 1", "tag 2"],
"cf_custom_field_example": ["Option1", "Option2"],
"legal_bases": [
{
"category": "communications",
"type": "consent",
"status": "granted"
}
],
"company": {
"name": "Company Example 0"
},
"funnel": {
"name": "default",
"lifecycle_stage": "Lead",
"opportunity": false,
"contact_owner_email": "[email protected]",
"interest": 20,
"fit": 0,
"origin": "Busca Paga | Google"
}
}
}
Os custom fields são prefixados com "cf_". Caso a entidade não possua o campo personalizado com um valor preenchido, ele não será enviado.
Legenda dos campos enviados no payload padrão
Confira abaixo cada campo enviado pelo webhook e o que cada um deles representa:
| Campo | Tipo | Descrição |
|---|---|---|
| event_type | String | O tipo de evento que acionou a solicitação do webhook. Atualmente, apenas WEBHOOK.CONVERTED ou WEBHOOK.MARKED_OPPORTUNITY são opções válidas. |
| entity_type | String | A entidade enviada no webhook. Atualmente, apenas CONTACT é uma opção válida. |
| event_identifier | String | O identificador do evento que acionou a solicitação do webhook, quando o event_type é WEBHOOK.CONVERTED. Para WEBHOOK.MARKED_OPPORTUNITY esse campo vai com o valor 'default'. |
| timestamp | DateTime | A hora em que o webhook foi enviado. |
| event_timestamp | DateTime | A hora em que ocorreu o evento que acionou o webhook. |
| contact | Object | A própria entidade, pode ser company ou qualquer outra entidade suportada. |
| uuid | Identificador único do contato. | |
| Email do contato. | ||
| name | Nome do contato. | |
| job_title | Cargo do contato. | |
| bio | Anotações do Perfil do contato. | |
| website | Site do contato. | |
| personal_phone | Telefone do contato. | |
| mobile_phone | Celular do contato. | |
| city | Cidade. | |
| Facebook do contato. | ||
| Linkedin do contato. | ||
| Twitter do contato. | ||
| tags | Tags do contato. | |
| cf_custom_field_example | Campos personalizados do contato. | |
| company | Empresa do contato. | |
| lifecycle_stage | Estágio do funil do contato. | |
| opportunity | Se o contato é oportunidade. | |
| contact_owner_email | Dono do contato. | |
| interest | Interesse do Lead Scoring do contato. | |
| fit | Perfil do Lead Scoring do contato. | |
| origin | Origem do contato (utm_medium e utm_source). | |
| legal_bases | Bases Legais do contato. |
O webhook envia um payload padrão em JSON único e imutável.
Não é possível personalizar os dados enviados pelo webhook.