Nota: O evento de negociaĆ§Ć£o do CRM estĆ” disponĆvel somente para planos Basic e PRO do CRM
Corpo da requisiĆ§Ć£o
Quando o evento configurado no Webhook Ć© acionado, o RD Station CRM 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 NegociaĆ§Ć£o do CRM - Create/Update/Delete
{
{
"event_name": "crm_deal_created",
"document":{
"id":"650878567482d9c0c7002050a475",
"name":"Teste NegociaĆ§Ć£o",
"amount_monthly":0.0,
"amount_unique":0.0,
"amount_total":0.0,
"prediction_date":null,
"created_at":"2023-09-18T15:04:34.515-03:00",
"updated_at":"2023-09-18T15:04:34.515-03:00",
"rating":1,
"status":"ongoing",
"closed_at":null,
"user":{
"id":"622e7fb2f678470c001576f4a4",
"name":"Hian Almada",
"email":"[email protected]",
"avatar_url":null
},
"deal_stage":{
"id":"622e4cee412e87000d2f52a6",
"name":"Sem contato",
"nickname":"SC",
"created_at":"2022-03-13T16:58:38.951-03:00",
"updated_at":"2022-03-13T16:58:38.951-03:00",
"order":1
},
"deal_pipeline":{
"id":"622e4cee111e87000d2f52a5",
"name":"Funil PadrĆ£o"
},
"deal_source":{
},
"campaign":{
},
"deal_lost_reason":{
},
"deal_custom_fields":[
{
"value":null,
"custom_field":{
"id":"611e89b0f269d0000b3bb2c2",
"label":"Whatsapp",
"required":false,
"unique":false,
"opts":[
],
"type":"text"
}
},
{
"value":null,
"custom_field":{
"id":"112e89ca673c7300162f15b3",
"label":"Instagram",
"required":false,
"unique":false,
"opts":[
],
"type":"text"
}
},
{
"value":null,
"custom_field":{
"id":"622e89e9f329d0000f3bb17a",
"label":"Qual a sua idade?",
"required":false,
"unique":false,
"opts":[
],
"type":"text"
}
},
{
"value":null,
"custom_field":{
"id":"622e8a32f269d0011f3bb17d",
"label":"De onde vocĆŖ conhece a Issues?",
"required":false,
"unique":false,
"opts":[
"Selecione",
"Redes Sociais",
"IndicaĆ§Ć£o",
"Pesquisa no Goole",
"Evento",
"Pista de skate"
],
"type":"option"
}
},
{
"value":null,
"custom_field":{
"id":"6258480fd71568001128705a",
"label":"Unidade",
"required":false,
"unique":false,
"opts":[
"FlorianĆ³polis",
"SĆ£o Paulo"
],
"type":"multiple_choice"
}
}
],
"deal_products":[
]
},
"event_timestamp":"2023-09-18T18:04:34.000Z",
"transaction_uuid":"f111b90-ec81-4353-8d52-ffd3b8df412d"
}
{
{
"event_name": "crm_deal_updated",
"document":{
"id":"650878567482d9c0c7002050a475",
"name":"Teste NegociaĆ§Ć£o",
"amount_monthly":0.0,
"amount_unique":0.0,
"amount_total":0.0,
"prediction_date":null,
"created_at":"2023-09-18T15:04:34.515-03:00",
"updated_at":"2023-09-18T15:04:34.515-03:00",
"rating":1,
"status":"ongoing",
"closed_at":null,
"user":{
"id":"622e7fb2f678470c001576f4a4",
"name":"Hian Almada",
"email":"[email protected]",
"avatar_url":null
},
"deal_stage":{
"id":"622e4cee412e87000d2f52a6",
"name":"Sem contato",
"nickname":"SC",
"created_at":"2022-03-13T16:58:38.951-03:00",
"updated_at":"2022-03-13T16:58:38.951-03:00",
"order":1
},
"deal_pipeline":{
"id":"622e4cee111e87000d2f52a5",
"name":"Funil PadrĆ£o"
},
"deal_source":{
},
"campaign":{
},
"deal_lost_reason":{
},
"deal_custom_fields":[
{
"value":null,
"custom_field":{
"id":"611e89b0f269d0000b3bb2c2",
"label":"Whatsapp",
"required":false,
"unique":false,
"opts":[
],
"type":"text"
}
},
{
"value":null,
"custom_field":{
"id":"112e89ca673c7300162f15b3",
"label":"Instagram",
"required":false,
"unique":false,
"opts":[
],
"type":"text"
}
},
{
"value":null,
"custom_field":{
"id":"622e89e9f329d0000f3bb17a",
"label":"Qual a sua idade?",
"required":false,
"unique":false,
"opts":[
],
"type":"text"
}
},
{
"value":null,
"custom_field":{
"id":"622e8a32f269d0011f3bb17d",
"label":"De onde vocĆŖ conhece a Issues?",
"required":false,
"unique":false,
"opts":[
"Selecione",
"Redes Sociais",
"IndicaĆ§Ć£o",
"Pesquisa no Goole",
"Evento",
"Pista de skate"
],
"type":"option"
}
},
{
"value":null,
"custom_field":{
"id":"6258480fd71568001128705a",
"label":"Unidade",
"required":false,
"unique":false,
"opts":[
"FlorianĆ³polis",
"SĆ£o Paulo"
],
"type":"multiple_choice"
}
}
],
"deal_products":[
]
},
"event_timestamp":"2023-09-18T18:04:34.000Z",
"transaction_uuid":"f111b90-ec81-4353-8d52-ffd3b8df412d"
}
{
"event_name":"crm_deal_deleted",
"document":{
"id":"64df7a11113f80018644923",
"name":"Teste NegociaĆ§Ć£o"
},
"event_timestamp":"2023-11-14T18:43:09.000Z",
"transaction_uuid":"b2daa3cb-23b1-497f-afb5-a5e4acda9374"
}
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_name | String | O tipo de evento que acionou a solicitaĆ§Ć£o do webhook. Atualmente, apenas CRM_DEAL_CREATED. ou CRM_DEAL_UPDATED ou CRM_DEAL_DELETED sĆ£o opƧƵes vĆ”lidas. |
| event_timestamp | DateTime | A hora em que ocorreu o evento que acionou o webhook. |
| transaction_uuid | UUID | Identificador Ćŗnico do evento. |
| document | Object | Objeto contendo objetos com as informaƧƵes da negociaĆ§Ć£o |
| user | Object | UsuĆ”rio relacionado a negociaĆ§Ć£o |
| deal_stage | Object | EstĆ”gio da negociaĆ§Ć£o no fluxo |
| deal_pipeline | Object | Funil do CRM em que a negociaĆ§Ć£o se encontra |
| deal_source | Object | Fonte da negociaĆ§Ć£o |
| campaign | Object | InformaĆ§Ć£o das campanhas referente Ć entrada das negociaƧƵes |
| deal_lost_reason | Object | Motivo da perda da negociaĆ§Ć£o |
| deal_custom_fields | Object | Campos personalizados da negociaĆ§Ć£o |
| deal_products | Object | Produtos e serviƧos presentes na negociaĆ§Ć£o |
| amount_unique | Object | Valor Ćŗnico |
| amount_monthly | Object | Valor recorrente |
| amount_annual | Object | Valor total (soma do valor Ćŗnico e valor recorrente) |
O webhook envia um payload padrĆ£o em JSON Ćŗnico e imutĆ”vel.
NĆ£o Ć© possĆvel personalizar os dados enviados pelo webhook.