Actions56
- Message Actions
- Instance Actions
- Connection Actions
- Profile Actions
- Behavior Actions
- Anti-Ban (Legacy) Actions
- Anti-Ban V2 Actions
- Handoff Actions
- Webhook Actions
- Media Actions
- System Actions
Instance → Onboard
AI-generatedSummary
Onboards a WhatsApp number in a single call by POSTing to the Wasup /api/onboard endpoint. The call creates the instance, applies the optional settings and starts pairing.
Inputs
- phone (required) — Phone number with country code. The + prefix is optional. Sent as
phone. - additionalFields.name — Friendly name for the instance.
- additionalFields.webhookUrl — URL that receives inbound message events for this instance.
- additionalFields.profileName — WhatsApp display name, applied once the number is connected.
- additionalFields.profileStatus — WhatsApp "About" text, applied once the number is connected.
- additionalFields.behaviorProfile — One of bot-native, notification-balanced or notification-max. Sent as
behaviorSettings.behaviorProfile. The UI default is bot-native, but the profile is only sent if you add this field.
Output shape
One JSON item per input item, containing the Wasup API's response to the onboard request as returned by the server.
The node doesn't shape the response, so its exact fields depend on the Wasup server. Empty optional fields are omitted from the request. If Continue On Fail is enabled, a failed item returns
{error: message}instead of stopping the workflow.
Examples
Example 1: Provision a new customer number with a webhook into your n8n workflow.
Phone = 447393002183; Additional Fields: Name = "Acme Support", Webhook URL = your n8n webhook URL.
Example 2: Onboard a number used for handset notifications with a branded profile.
Phone from the incoming item; Behavior Profile = Notification Balanced, Profile Name = "Acme", Profile Status = "We reply within minutes!".