Create Bot Integration via API

Bot Integration

Create Bot Integration

POST https://{{domain-admin}}.ekoapp.com/bot-integration

create bot integration

Headers

Name	Type	Description
Accept	string	application/json, text/plain, /
Content-type	string	application/x-www-form-urlencoded
X-XSRF-TOKEN	string	CSRF token for request validation. Obtained from the XSRF-TOKEN cookie.
Cookie	string	Session cookies including adonis-session and XSRF-TOKEN.

Request Body Parameters

Name	Type	Description
enabled*	boolean	Enable or disable the bot integration. Accepts true or false.
firstname*	string	First name of the bot.
lastname	string	Last name of the bot.
username*	string	Unique username identifier for the bot.
position	string	Position or role title of the bot (e.g., “Customer Support”).
status	string	Status message for the bot.
webhookUrl*	string	The webhook URL that will receive incoming messages and events. Must be a valid URL (HTTPS recommended).
avatar	string	URL or file reference for the bot’s avatar image.
coverPhoto	string	URL or file reference for the bot’s cover photo.
integrationType*	string	Type of integration. Use webhook for webhook-based integrations.

200

{
  "status": "success",
  "data": {
    "id": "bot_abc123",
    "enabled": true,
    "firstname": "MyBot",
    "lastname": "Assistant",
    "username": "mybot-assistant",
    "position": "Customer Support",
    "status": "online",
    "webhookUrl": "https://your-server.com/webhook",
    "integrationType": "webhook",
    "createdAt": "2026-03-13T10:00:00.000Z",
    "updatedAt": "2026-03-13T10:00:00.000Z"
  }
}

// example
curl --location 'https://{{domain}}-admin.ekoapp.com/bot-integration' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Accept: application/json, text/plain, */*' \
--header 'X-XSRF-TOKEN: {xsrf_token}' \
--header 'Cookie: adonis-session={session_id}; XSRF-TOKEN={xsrf_token}' \
--data-urlencode 'enabled=true' \
--data-urlencode 'firstname=MyBot' \
--data-urlencode 'lastname=Assistant' \
--data-urlencode 'username=mybot-assistant' \
--data-urlencode 'position=Customer Support' \
--data-urlencode 'status=online' \
--data-urlencode 'webhookUrl=https://your-server.com/webhook' \
--data-urlencode 'avatar=' \
--data-urlencode 'coverPhoto=' \
--data-urlencode 'integrationType=webhook'