Response format

​

Description

​

Envelope

{
  "event": "message",
  "botId": "BOT_ID",
  "userId": "user-123",
  "message": {
    "messageId": "msg-1",
    "type": "TEXT"
  }
}

​

Delivery headers

• Content-Type: application/json
• Auth from credentials.auth (when configured):
  • api_key → configurable header (default X-Api-Key)
  • bearer → Authorization: Bearer <value>
  • basic → value is the full username:password string before Base64; the header is Authorization: Basic <base64(username:password)>
• X-Jelou-Signature: sha256=<hmac> computed over the exact raw HTTP body bytes (always present; the signing key is required). Verify against that raw body before parsing it as JSON; do not re-serialize the parsed object.

​

Message types (message)

​

Examples

{
  "event": "message",
  "botId": "BOT_ID",
  "userId": "user-123",
  "message": {
    "messageId": "msg-1",
    "type": "TEXT",
    "text": "How can we help you?"
  }
}

{
  "event": "message",
  "botId": "BOT_ID",
  "userId": "user-123",
  "message": {
    "messageId": "msg-2",
    "type": "BUTTONS",
    "text": "Pick an option",
    "title": "Menu",
    "options": [
      { "title": "Support", "description": "" },
      { "title": "Sales", "description": "" }
    ]
  }
}

{
  "event": "message",
  "botId": "BOT_ID",
  "userId": "user-123",
  "message": {
    "messageId": "msg-3",
    "type": "IMAGE",
    "mediaUrl": "https://cdn.example.com/photo.jpg",
    "caption": "Receipt"
  }
}