Create Instance
https://{server-url}
Authorizations
Your authorization key header
Body
instance (Instance name)
apikey (Enter or leave empty to create dynamically)
559999999999 (Instance owner number with Country Code)
Create QR Code automatically after creation
WhatsApp engine
WHATSAPP-BAILEYS
, WHATSAPP-BUSINESS
Reject WhatsApp calls automatically
Message to be sent when a call is rejected automatically
Ignore group messages
Keep WhatsApp always online
Send read receipts to received messages
Show sent messages read status
Whether to sync the full history of messages and chats or not
Proxy host
Proxy port
Proxy protocol
http
, https
Proxy username
Proxy password
Webhook URL
Enables the Webhook by events
Sends media files on base64 via Webhook
Events to be sent to the Webhook
APPLICATION_STARTUP
, QRCODE_UPDATED
, MESSAGES_SET
, MESSAGES_UPSERT
, MESSAGES_UPDATE
, MESSAGES_DELETE
, SEND_MESSAGE
, CONTACTS_SET
, CONTACTS_UPSERT
, CONTACTS_UPDATE
, PRESENCE_UPDATE
, CHATS_SET
, CHATS_UPSERT
, CHATS_UPDATE
, CHATS_DELETE
, GROUPS_UPSERT
, GROUP_UPDATE
, GROUP_PARTICIPANTS_UPDATE
, CONNECTION_UPDATE
, LABELS_EDIT
, LABELS_ASSOCIATION
, CALL
, TYPEBOT_START
, TYPEBOT_CHANGE_STATUS
Enables RabbitMQ
Events to be sent to the RabbitMQ
APPLICATION_STARTUP
, QRCODE_UPDATED
, MESSAGES_SET
, MESSAGES_UPSERT
, MESSAGES_UPDATE
, MESSAGES_DELETE
, SEND_MESSAGE
, CONTACTS_SET
, CONTACTS_UPSERT
, CONTACTS_UPDATE
, PRESENCE_UPDATE
, CHATS_SET
, CHATS_UPSERT
, CHATS_UPDATE
, CHATS_DELETE
, GROUPS_UPSERT
, GROUP_UPDATE
, GROUP_PARTICIPANTS_UPDATE
, CONNECTION_UPDATE
, LABELS_EDIT
, LABELS_ASSOCIATION
, CALL
, TYPEBOT_START
, TYPEBOT_CHANGE_STATUS
Enable SQS
Events to be sent to the SQS
APPLICATION_STARTUP
, QRCODE_UPDATED
, MESSAGES_SET
, MESSAGES_UPSERT
, MESSAGES_UPDATE
, MESSAGES_DELETE
, SEND_MESSAGE
, CONTACTS_SET
, CONTACTS_UPSERT
, CONTACTS_UPDATE
, PRESENCE_UPDATE
, CHATS_SET
, CHATS_UPSERT
, CHATS_UPDATE
, CHATS_DELETE
, GROUPS_UPSERT
, GROUP_UPDATE
, GROUP_PARTICIPANTS_UPDATE
, CONNECTION_UPDATE
, LABELS_EDIT
, LABELS_ASSOCIATION
, CALL
, TYPEBOT_START
, TYPEBOT_CHANGE_STATUS
Chatwoot account ID
Chatwoot authentication token
Chatwoot server URL
Send message signature on Chatwoot
Reopen conversation on Chatwoot
Start the conversation as pending instead of open
Import contacts from WhatsApp to Chatwoot
Chatwoot inbox name (uses the instance name if empty)
Whether to merge Brazilian number contacts with and without the additional 9
. Ex: 553198765432
merges with 5531998765432
Specifies how many days' messages to import from today
Chatwoot organization name
Chatwoot logo URL
Typebot server URL
Typebot flow name
Time to expire the session in seconds
Keyword to finish the typebot flow (escape keyword)
Default delay for the typebot messages
TODO
Typebot listen messages sent by the connected number