Communication.send

POST https://webhook.example.com

Subscribe to these events to be notified whenever a communication or reminder must be send to the participants of an appointment or callback request.

application/json

Body

  • id string Required

    Minimum length is 1.

  • correlationId string Required

    Minimum length is 1.

  • entity string Required

    Value is Communication.

  • version string Required

    Minimum length is 1.

  • webhookConfigurationId string Required

    Minimum length is 1.

  • data object Required
    Hide data attributes Show data attributes object
    • communication object Required

      Additional properties are NOT allowed.

      Hide communication attributes Show communication attributes object
    • receiver object Required

      Additional properties are NOT allowed.

      Hide receiver attributes Show receiver attributes object
    • template object Required

      Additional properties are NOT allowed.

      Hide template attributes Show template attributes object
      • language string Required

        Minimum length is 1.

      • timeZone string Required

        Minimum length is 1.

      • content string Required

        Minimum length is 1.

      • subject string | null

        Minimum length is 1.

      • images array[object] Required
        Hide images attributes Show images attributes object
    • resource object | null Required

      Any of:

Responses

  • Your server returns this code if it succesfully processed the event

  • Your server returns this code if it succesfully processed the event

  • Your server returns this code if it succesfully processed the event

  • Your server returns this code if it succesfully processed the event

POST CommunicationWebhook
Request examples
{
  "id": "string",
  "correlationId": "string",
  "entity": "Communication",
  "version": "string",
  "webhookConfigurationId": "string",
  "data": {
    "communication": {
      "resourceId": "string",
      "resourceType": "string",
      "channel": "string",
      "receiverId": "string",
      "receiverType": "string",
      "receiverRole": "string",
      "communicationType": "string",
      "correlationId": "string",
      "scheduledAt": "2022-08-17T19:05:21.362Z",
      "createdAt": "2022-08-17T19:05:21.362Z"
    },
    "receiver": {
      "fullName": "string",
      "email": "string",
      "phoneNumber": "string",
      "language": "string",
      "timeZone": "string"
    },
    "template": {
      "language": "string",
      "timeZone": "string",
      "content": "string",
      "subject": "string",
      "images": [
        {
          "name": "string",
          "content": "string",
          "contentType": "string"
        }
      ]
    },
    "resource": {
      "eventType": "string",
      "message": "string",
      "appointment": {
        "status": "string",
        "start": "string",
        "end": "string",
        "id": "123",
        "subject": {
          "id": "123",
          "externalId": "ABCD1234",
          "enabledForCustomerUse": true,
          "enabledForInternalUse": true,
          "order": 5,
          "cancellationByAgentForm": {
            "id": "123"
          },
          "cancellationByCustomerForm": {
            "id": "123"
          },
          "completionByAgentForm": {
            "id": "123"
          },
          "questionnaireForm": {
            "id": "123"
          },
          "subjectGroup": {
            "id": "123",
            "externalId": "ABCD1234",
            "order": 5,
            "color": "string",
            "image": "string",
            "translations": {
              "name": [
                {
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "createdAt": "2022-08-17T19:05:21.362Z",
            "updatedAt": "2022-08-17T19:05:21.362Z",
            "deletedAt": "2022-08-17T19:05:21.362Z"
          },
          "translations": {
            "name": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "description": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "instructions": [
              {
                "language": "string",
                "value": "string"
              }
            ]
          },
          "createdAt": "2022-08-17T19:05:21.362Z",
          "updatedAt": "2022-08-17T19:05:21.362Z",
          "deletedAt": "2022-08-17T19:05:21.362Z"
        },
        "office": {
          "id": "123",
          "active": true,
          "email": "string",
          "externalId": "ABCD1234",
          "phoneNumber": "string",
          "timeZone": "string",
          "usesIndependentAgents": true,
          "virtual": true,
          "location": {
            "postalCode": "string",
            "countryCode": "string",
            "geolocation": {
              "latitude": 51.0479466,
              "longitude": 3.6912248
            },
            "translations": {
              "city": [
                {
                  "language": "string",
                  "value": "string"
                }
              ],
              "street1": [
                {
                  "language": "string",
                  "value": "string"
                }
              ],
              "street2": [
                {
                  "language": "string",
                  "value": "string"
                }
              ],
              "state": [
                {
                  "language": "string",
                  "value": "string"
                }
              ]
            }
          },
          "translations": {
            "name": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "description": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "directions": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "parkingInfo": [
              {
                "language": "string",
                "value": "string"
              }
            ]
          },
          "createdAt": "2022-08-17T19:05:21.362Z",
          "updatedAt": "2022-08-17T19:05:21.362Z",
          "deletedAt": "2022-08-17T19:05:21.362Z"
        },
        "participants": [
          {
            "role": "string",
            "token": "string",
            "type": "string",
            "videoUrl": "string",
            "videoTestUrl": "string",
            "createdAt": "2022-08-17T19:05:21.362Z",
            "employee": {
              "id": "123",
              "communicationEmail": "string",
              "email": "string",
              "externalId": "ABCD1234",
              "firstName": "string",
              "lastName": "string",
              "language": "string",
              "onlinePlanning": true,
              "phoneNumber": "string",
              "profilePictureUrl": "string",
              "staticVideoUrl": "string",
              "translations": {
                "function": [
                  {
                    "language": "string",
                    "value": "string"
                  }
                ]
              },
              "availableRoles": [
                "string"
              ],
              "status": "string",
              "timeZone": "string",
              "createdAt": "2022-08-17T19:05:21.362Z",
              "updatedAt": "2022-08-17T19:05:21.362Z",
              "deletedAt": "2022-08-17T19:05:21.362Z"
            },
            "customer": {
              "id": "123",
              "company": "string",
              "customerNumber": "string",
              "email": "string",
              "existing": true,
              "externalId": "ABCD1234",
              "firstName": "string",
              "lastName": "string",
              "language": "string",
              "phoneNumber": "string",
              "timeZone": "string",
              "location": {
                "postalCode": "string",
                "countryCode": "string",
                "geolocation": {
                  "latitude": 51.0479466,
                  "longitude": 3.6912248
                },
                "translations": {
                  "city": [
                    {
                      "language": "string",
                      "value": "string"
                    }
                  ],
                  "street1": [
                    {
                      "language": "string",
                      "value": "string"
                    }
                  ],
                  "street2": [
                    {
                      "language": "string",
                      "value": "string"
                    }
                  ],
                  "state": [
                    {
                      "language": "string",
                      "value": "string"
                    }
                  ]
                }
              }
            },
            "cancelUrl": "string",
            "editUrl": "string",
            "inviteUrl": "string",
            "declineUrl": "string",
            "office365CalendarUrl": "string",
            "googleCalendarUrl": "string",
            "icalUrl": "string"
          }
        ],
        "answers": [
          {
            "id": "123",
            "form": {
              "id": "123"
            },
            "question": {
              "id": "123",
              "externalId": "ABCD1234",
              "order": 5,
              "translations": {
                "label": [
                  {
                    "language": "string",
                    "value": "string"
                  }
                ]
              },
              "createdAt": "2022-08-17T19:05:21.362Z",
              "updatedAt": "2022-08-17T19:05:21.362Z",
              "deletedAt": "2022-08-17T19:05:21.362Z"
            },
            "answerType": "string",
            "value": "string",
            "selectedAnswerOptions": [
              {
                "id": "123",
                "externalId": "ABCD1234",
                "value": "string",
                "createdAt": "2022-08-17T19:05:21.362Z",
                "updatedAt": "2022-08-17T19:05:21.362Z",
                "deletedAt": "2022-08-17T19:05:21.362Z"
              }
            ],
            "files": [
              {
                "id": "123"
              }
            ],
            "createdAt": "2022-08-17T19:05:21.362Z",
            "updatedAt": "2022-08-17T19:05:21.362Z"
          }
        ],
        "callbackRequest": {
          "id": "123"
        },
        "location": {
          "postalCode": "string",
          "countryCode": "string",
          "geolocation": {
            "latitude": 51.0479466,
            "longitude": 3.6912248
          },
          "translations": {
            "city": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "street1": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "street2": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "state": [
              {
                "language": "string",
                "value": "string"
              }
            ]
          }
        },
        "listing": {
          "id": "123",
          "active": true,
          "externalId": "string",
          "timeZone": "string",
          "tags": [
            "string"
          ],
          "location": {
            "postalCode": "string",
            "countryCode": "string",
            "geolocation": {
              "latitude": 51.0479466,
              "longitude": 3.6912248
            },
            "translations": {
              "city": [
                {
                  "language": "string",
                  "value": "string"
                }
              ],
              "street1": [
                {
                  "language": "string",
                  "value": "string"
                }
              ],
              "street2": [
                {
                  "language": "string",
                  "value": "string"
                }
              ],
              "state": [
                {
                  "language": "string",
                  "value": "string"
                }
              ]
            }
          },
          "translations": {
            "name": [
              {
                "language": "string",
                "value": "string"
              }
            ],
            "description": [
              {
                "language": "string",
                "value": "string"
              }
            ]
          },
          "createdAt": "2022-08-17T19:05:21.362Z",
          "updatedAt": "2022-08-17T19:05:21.362Z",
          "deletedAt": "2022-08-17T19:05:21.362Z"
        },
        "leadSegment": {
          "id": "123",
          "code": "string",
          "description": "string",
          "createdAt": "2022-08-17T19:05:21.362Z",
          "updatedAt": "2022-08-17T19:05:21.362Z",
          "deletedAt": "2022-08-17T19:05:21.362Z"
        },
        "meetingType": "string",
        "externalId": "ABCD1234",
        "hybrid": true,
        "trailingBufferTime": 5,
        "internalNotes": "string",
        "meetingRoom": {
          "id": "123",
          "email": "string",
          "external": "ABCD1234",
          "name": "string",
          "provider": "string",
          "createdAt": "2022-08-17T19:05:21.362Z",
          "updatedAt": "2022-08-17T19:05:21.362Z",
          "deletedAt": "2022-08-17T19:05:21.362Z"
        },
        "messageForCustomer": "string",
        "userCommunication": {
          "notifications": "string",
          "notificationsOverrideCurrentAction": "string",
          "reminders": "string"
        },
        "createdAt": "2022-08-17T19:05:21.362Z",
        "createdById": "string",
        "createdByType": "string",
        "createdFrom": "string",
        "updatedAt": "2022-08-17T19:05:21.362Z",
        "updatedById": "string",
        "updatedByType": "string",
        "updatedFrom": "string"
      },
      "previousAppointment": null
    }
  }
}