Callback-request.create

POST https://webhook.example.com

A new callback request is created on your environment. Subscribe to these events to update relevant documents in your CRM or other dataflows.

application/json

Body

  • id string Required

    Minimum length is 1.

  • correlationId string Required

    Minimum length is 1.

  • entity string Required

    Value is Callback Request.

  • version string Required

    Minimum length is 1.

  • webhookConfigurationId string Required

    Minimum length is 1.

  • data object Required

    Additional properties are NOT allowed.

    Hide data attributes Show data attributes object
    • eventType string Required

      Minimum length is 1.

    • callbackRequest object Required

      Additional properties are NOT allowed.

      Hide callbackRequest attributes Show callbackRequest attributes object
      • id string Required

        Minimum length is 1.

      • status string Required

        Minimum length is 1.

      • subject object | null Required

        Additional properties are NOT allowed.

        Hide subject attributes Show subject attributes object | null
        • id string Required

          Minimum length is 1.

        • externalId string Required

          Minimum length is 1, maximum length is 255.

        • enabledForCustomerUse boolean Required
        • enabledForInternalUse boolean Required
        • order integer Required

          Minimum value is 0.

        • cancellationByAgentForm object | null Required
          Hide cancellationByAgentForm attribute Show cancellationByAgentForm attribute object | null
          • id string Required

            Minimum length is 1.

        • cancellationByCustomerForm object | null Required
          Hide cancellationByCustomerForm attribute Show cancellationByCustomerForm attribute object | null
          • id string Required

            Minimum length is 1.

        • completionByAgentForm object | null Required
          Hide completionByAgentForm attribute Show completionByAgentForm attribute object | null
          • id string Required

            Minimum length is 1.

        • questionnaireForm object | null Required
          Hide questionnaireForm attribute Show questionnaireForm attribute object | null
          • id string Required

            Minimum length is 1.

        • subjectGroup object Required
          Hide subjectGroup attributes Show subjectGroup attributes object
          • id string Required

            Minimum length is 1.

          • externalId string Required

            Minimum length is 1, maximum length is 255.

          • order integer Required

            Minimum value is 0.

          • color string Required

            Minimum length is 1.

          • image string | null

            Minimum length is 1.

          • translations object Required
            Hide translations attribute Show translations attribute object
            • name array[object] Required
              Hide name attributes Show name attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

          • createdAt string(date-time) Required

            Minimum length is 1.

          • updatedAt string(date-time) Required

            Minimum length is 1.

          • deletedAt string(date-time) | null Required

            Minimum length is 1.

        • translations object Required
          Hide translations attributes Show translations attributes object
          • name array[object] Required
            Hide name attributes Show name attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • description array[object] Required
            Hide description attributes Show description attributes object
          • instructions array[object] Required
            Hide instructions attributes Show instructions attributes object
        • createdAt string(date-time) Required

          Minimum length is 1.

        • updatedAt string(date-time) Required

          Minimum length is 1.

        • deletedAt string(date-time) | null Required

          Minimum length is 1.

      • office object | null Required

        Additional properties are NOT allowed.

        Hide office attributes Show office attributes object | null
        • id string Required

          Minimum length is 1.

        • active boolean Required
        • email string | null

          Minimum length is 1.

        • externalId string Required

          Minimum length is 1, maximum length is 255.

        • phoneNumber string | null

          Minimum length is 1.

        • timeZone string Required

          Minimum length is 1.

        • usesIndependentAgents boolean Required
        • virtual boolean Required
        • location object Required

          Additional properties are NOT allowed.

          Hide location attributes Show location attributes object
          • postalCode string | null Required
          • countryCode string Required

            Minimum length is 1.

          • geolocation object Required
            Hide geolocation attributes Show geolocation attributes object
            • latitude number Required

              Minimum value is -90, maximum value is 90.

            • longitude number Required

              Minimum value is -180, maximum value is 180.

          • translations object Required
            Hide translations attributes Show translations attributes object
            • city array[object] Required
              Hide city attributes Show city attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

            • street1 array[object] Required
              Hide street1 attributes Show street1 attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

            • street2 array[object] Required
              Hide street2 attributes Show street2 attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

            • state array[object] Required
              Hide state attributes Show state attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

        • translations object Required
          Hide translations attributes Show translations attributes object
          • name array[object] Required
            Hide name attributes Show name attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • description array[object] Required
            Hide description attributes Show description attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • directions array[object] Required
            Hide directions attributes Show directions attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • parkingInfo array[object] Required
            Hide parkingInfo attributes Show parkingInfo attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

        • createdAt string(date-time) Required

          Minimum length is 1.

        • updatedAt string(date-time) Required

          Minimum length is 1.

        • deletedAt string(date-time) | null Required

          Minimum length is 1.

      • participants array[object] Required
        Hide participants attributes Show participants attributes object
        • role string Required

          Minimum length is 1.

        • type string Required

          Minimum length is 1.

        • createdAt string(date-time) Required

          Minimum length is 1.

        • employee object

          Additional properties are NOT allowed.

          Hide employee attributes Show employee attributes object
        • customer object

          Additional properties are NOT allowed.

          Hide customer attributes Show customer attributes object
          • id string Required

            Minimum length is 1.

          • company string | null

            Minimum length is 1.

          • customerNumber string | null

            Minimum length is 1.

          • email string | null

            Minimum length is 1.

          • existing boolean Required
          • externalId string Required

            Minimum length is 1, maximum length is 255.

          • firstName string | null

            Minimum length is 1.

          • lastName string | null

            Minimum length is 1.

          • language string Required

            Minimum length is 1.

          • phoneNumber string | null

            Minimum length is 1.

          • timeZone string Required

            Minimum length is 1.

          • location object | null Required

            Additional properties are NOT allowed.

            Hide location attributes Show location attributes object | null
            • postalCode string | null Required
            • countryCode string Required

              Minimum length is 1.

            • geolocation object Required
              Hide geolocation attributes Show geolocation attributes object
              • latitude number Required

                Minimum value is -90, maximum value is 90.

              • longitude number Required

                Minimum value is -180, maximum value is 180.

            • translations object Required
              Hide translations attributes Show translations attributes object
              • city array[object] Required
                Hide city attributes Show city attributes object
                • language string Required

                  Minimum length is 1.

                • value string Required

                  Minimum length is 1.

              • street1 array[object] Required
                Hide street1 attributes Show street1 attributes object
                • language string Required

                  Minimum length is 1.

                • value string Required

                  Minimum length is 1.

              • street2 array[object] Required
                Hide street2 attributes Show street2 attributes object
                • language string Required

                  Minimum length is 1.

                • value string Required

                  Minimum length is 1.

              • state array[object] Required
                Hide state attributes Show state attributes object
                • language string Required

                  Minimum length is 1.

                • value string Required

                  Minimum length is 1.

        • cancelUrl string Required

          Minimum length is 1.

        • editUrl string Required

          Minimum length is 1.

        • inviteUrl string Required

          Minimum length is 1.

        • declineUrl string Required

          Minimum length is 1.

        • office365CalendarUrl string Required

          Minimum length is 1.

        • googleCalendarUrl string Required

          Minimum length is 1.

        • icalUrl string Required

          Minimum length is 1.

      • answers array[object] Required
        Hide answers attributes Show answers attributes object
        • id string Required

          Minimum length is 1.

        • form object Required
          Hide form attribute Show form attribute object
          • id string Required

            Minimum length is 1.

        • question object Required

          Additional properties are NOT allowed.

          Hide question attributes Show question attributes object
          • id string Required

            Minimum length is 1.

          • externalId string Required

            Minimum length is 1, maximum length is 255.

          • order integer Required

            Minimum value is 0.

          • translations object Required
            Hide translations attribute Show translations attribute object
            • label array[object] Required
              Hide label attributes Show label attributes object
          • createdAt string(date-time) Required

            Minimum length is 1.

          • updatedAt string(date-time) Required

            Minimum length is 1.

          • deletedAt string(date-time) | null Required

            Minimum length is 1.

        • answerType string Required

          Minimum length is 1.

        • value string | null

          Minimum length is 1.

        • selectedAnswerOptions array[object] | null Required
          Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
          • id string Required

            Minimum length is 1.

          • externalId string Required

            Minimum length is 1, maximum length is 255.

          • value string | null

            Minimum length is 1.

          • createdAt string(date-time) Required

            Minimum length is 1.

          • updatedAt string(date-time) Required

            Minimum length is 1.

          • deletedAt string(date-time) | null Required

            Minimum length is 1.

        • files array[object] | null Required
          Hide files attribute Show files attribute object
          • id string Required

            Minimum length is 1.

        • createdAt string(date-time) Required

          Minimum length is 1.

        • updatedAt string(date-time) Required

          Minimum length is 1.

      • location object | null Required

        Additional properties are NOT allowed.

        Hide location attributes Show location attributes object | null
        • postalCode string | null Required
        • countryCode string Required

          Minimum length is 1.

        • geolocation object Required
          Hide geolocation attributes Show geolocation attributes object
          • latitude number Required

            Minimum value is -90, maximum value is 90.

          • longitude number Required

            Minimum value is -180, maximum value is 180.

        • translations object Required
          Hide translations attributes Show translations attributes object
          • city array[object] Required
            Hide city attributes Show city attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • street1 array[object] Required
            Hide street1 attributes Show street1 attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • street2 array[object] Required
            Hide street2 attributes Show street2 attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • state array[object] Required
            Hide state attributes Show state attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

      • listing object | null Required

        Additional properties are NOT allowed.

        Hide listing attributes Show listing attributes object | null
        • id string Required

          Minimum length is 1.

        • active boolean Required
        • externalId string | null

          Minimum length is 1.

        • timeZone string Required

          Minimum length is 1.

        • tags array[string] Required

          Minimum length of each is 1.

        • location object | null Required

          Additional properties are NOT allowed.

          Hide location attributes Show location attributes object | null
          • postalCode string | null Required
          • countryCode string Required

            Minimum length is 1.

          • geolocation object Required
            Hide geolocation attributes Show geolocation attributes object
            • latitude number Required

              Minimum value is -90, maximum value is 90.

            • longitude number Required

              Minimum value is -180, maximum value is 180.

          • translations object Required
            Hide translations attributes Show translations attributes object
            • city array[object] Required
              Hide city attributes Show city attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

            • street1 array[object] Required
              Hide street1 attributes Show street1 attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

            • street2 array[object] Required
              Hide street2 attributes Show street2 attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

            • state array[object] Required
              Hide state attributes Show state attributes object
              • language string Required

                Minimum length is 1.

              • value string Required

                Minimum length is 1.

        • translations object Required
          Hide translations attributes Show translations attributes object
          • name array[object] Required
            Hide name attributes Show name attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

          • description array[object] Required
            Hide description attributes Show description attributes object
            • language string Required

              Minimum length is 1.

            • value string Required

              Minimum length is 1.

        • createdAt string(date-time) Required

          Minimum length is 1.

        • updatedAt string(date-time) Required

          Minimum length is 1.

        • deletedAt string(date-time) | null Required

          Minimum length is 1.

      • leadSegment object | null Required

        Additional properties are NOT allowed.

        Hide leadSegment attributes Show leadSegment attributes object | null
        • id string Required

          Minimum length is 1.

        • code string Required

          Minimum length is 1.

        • description string | null

          Minimum length is 1.

        • createdAt string(date-time) Required

          Minimum length is 1.

        • updatedAt string(date-time) Required

          Minimum length is 1.

        • deletedAt string(date-time) | null Required

          Minimum length is 1.

      • meetingType string | null Required

        Minimum length is 1.

      • externalId string Required

        Minimum length is 1, maximum length is 255.

      • internalNotes string | null

        Minimum length is 1.

      • createdAt string(date-time) Required

        Minimum length is 1.

      • createdById string | null

        Minimum length is 1.

      • createdByType string Required

        Minimum length is 1.

      • createdFrom string Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

      • updatedById string | null

        Minimum length is 1.

      • updatedByType string Required

        Minimum length is 1.

      • updatedFrom string Required

        Minimum length is 1.

Responses

  • 200

    Your server returns this code if it succesfully processed the event

  • 201

    Your server returns this code if it succesfully processed the event

  • 202

    Your server returns this code if it succesfully processed the event

  • 204

    Your server returns this code if it succesfully processed the event

POST CallbackRequestCreate
Request examples 
{
  "id": "string",
  "correlationId": "string",
  "entity": "Callback Request",
  "version": "string",
  "webhookConfigurationId": "string",
  "data": {
    "eventType": "string",
    "callbackRequest": {
      "id": "123",
      "status": "string",
      "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",
          "type": "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"
        }
      ],
      "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",
      "internalNotes": "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"
    }
  }
}