API Reference

Handle first event

post
https://example.com/start

Whenever a user enters a box via its input connector, this endpoint will be invoked via POST URL/start.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The name of the backend this event is generated for

Allowed:
parameters
object
required

The set of key/value pairs associated with the per-box description parameters.

string
required

The raw id of the user in the underlying social network API

string
required

A user name associated with the underlying social network API

event
required
global_variables
object

A set of conversation variables that the bot box can read. Only variables specified in Description.input_variables are available.

Headers
string

Optional header for signature verification present if an Alcmeon application has been defined for the sub-bot.

Response

Updated 8 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago