Webhooks

Receive message

When a new message is coming from a user or bot in any created or subscribed conversation, this webhook will be triggered calling the provided <CALLBACK_URL> on the application setup phase with the conversation_id helping you define the conversation of this message

Request

POST <CALLBACK_URL>

{
    "conversation_id": 123,
    "content": {} // See message formats below
}

• Message formats

Expected Response

200 OK

Receive Events

When a contact is created or updated, this webhook will be triggered to notify CRM by calling the <CALLBACK_URLS> of each team subscribed for an event.

We have five events to create/modify a contact :

1. New contact

When a new contact is creating, this event will be triggered to notify CRM by calling all <CALLBACK_URLS> subscribed for this event.

Request

POST <CALLBACK_URL>

{
    "team": {
        "id": integer, // Team ID
        "name": string, // Team name
    },
    "contact": object, // See contact format below
    "conversation": object // See conversation format below
}

• Contact format
• ​Conversation format

2. Update contact

When a contact is updating, this event will be triggered to notify CRM by calling all <CALLBACK_URLS> subscribed for this event.

Request

POST <CALLBACK_URL>

{
    "team_id": integer, // Team ID,
    "contact": object // See contact format below
}

• Contact format

3. New reservation

When a new reservation is creating, this event will be triggered to notify CRM by calling all <CALLBACK_URLS> subscribed for this event.

Request

POST <CALLBACK_URL>

{
    "team_id": integer, // Team ID,
    "contact_id": integer, // Contact ID
    "contact_email": string, // Contact E-mail
    "reservation": object // See new reservation format below
}

• New reservation format

4. Update reservation status

When a reservation status is updating, this event will be triggered to notify CRM by calling all <CALLBACK_URLS> subscribed for this event.

Request

POST <CALLBACK_URL>

{
    "team_id": integer, // Team ID,
    "contact_id": integer, // Contact ID
    "contact_email": string, // Contact E-mail
    "reservation_id": integer, // Reservation ID
    "reservation_status": string // Reservation status ("Confirmed", "Not confirmed", "Deleted")
}

5. New tags

When a new tags are creating, this event will be triggered to notify CRM by calling all <CALLBACK_URLS> subscribed for this event.

Request

POST <CALLBACK_URL>

{
    "team_id": integer, // Team ID,
    "contact_id": integer, // Contact ID
    "contact_email": string, // Contact E-mail
    "tags": [
        string
    ] // Array of tags
}