Skip to main content

Webhook

Some data can be provided as a webhook callback. Below you see what events you can subscribe to and the data that comes with it. To add a webhook in ImBox, please contact ImBox Customer Service.

agentMessage​

Chat message from agent.

Example​

{
    "event": {
      "agent": {
        "email": "<agent.email>"
      },
      "channel": "V1234",
      "type": "agentMessage",
      "text": "Hej",
      "timestamp": "<message timestamp>"
    },
    "eventTime": "<webhook execute timestamp>"
  }
}

agentMessage with file (sendFile)​

Chat message from agent with file attachment.

Example​

{
    "event": {
      "agent": {
        "email": "<agent.email>"
      },
      "channel": "V1234",
      "type": "agentMessage",
      "text": "Hej",
      "timestamp": "<message timestamp>"
    },
    "eventTime": "<webhook execute timestamp>"
  }
}

visitorIdentification​

Visitor is identified.

Example​

{
  "event": {
    "visitor": {
      "id": "<visitorUuid>"
    },
    "channel": "V1234",
    "type": "visitorIdentification",
    "user": {
      "personalNumber": "198809293935",
      "name": "PER MORBERG",
      "givenName": "PER",
      "surname": "MORBERG"
    },
    "timestamp": "<message timestamp>"
  },
  "eventTime": "<webhook execute timestamp>"
}

visitorMessage​

Chat message from visitor.

Example​

{
    "event": {
      "visitor": {
        "id": "<visitorUuid>"
      },
      "channel": "V1234",
      "type": "visitorMessage",
      "text": "Hej",
      "timestamp": "<message timestamp>"
    },
    "eventTime": "<webhook execute timestamp>"
  }
}

visitorMessage with file (sendFile)​

Chat message from visitor with file attachment.

Example​

{
    "event": {
      "visitor": {
        "id": "<visitorUuid>"
      },
      "channel": "V1234",
      "type": "visitorMessage",
      "text": "Hej",
      "timestamp": "<message timestamp>"
    },
    "eventTime": "<webhook execute timestamp>"
  }
}