v1
latestOpenAPI 3.1.02026-07-1413113265.9 KBinstances
create instance
Create a new instance. Optionally set a name and webhook configuration.
post/instances
Request body
Example request
{
"name": "My first instance",
"webhook": {
"url": "https://my.url.com/webhook/handler",
"events": [
"message",
"qr"
]
}
}Response
The created instance
Example response
{
"instance": {
"id": 1,
"name": "My first instance",
"owner": "mail@example.com",
"webhook_url": "https://my.url.com/webhook/handler",
"webhook_events": [
"message",
"qr"
]
},
"status": "success"
}