For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integrated Onboarding

This page describes how to get started with triggering Integrated Onboarding to register phone numbers

The Integrated Onboarding (IO) solution offered by 360Dialog simplifies the process of creating and adding numbers in the WhatsApp Business Account, giving the partner flexibility to offer their clients the best experience possible.

Choosing the right Integrated Onboarding type depends on several factors, including technical capabilities, resources, and specific needs for integrating with the WhatsApp Business API.

Implementation Methods

Select one of the following implementation methods to get started:

Integrated onboarding can be started by linking to the partner's dedicated signup URL.

Ideal for: Partners who want to onboard numbers right away. Best for the quickest start.

✅ No-code ✅ Available immediately ✅ Standard user experience

Using Direct Link

Connect Button

The Connect Button is a basic Integrated Onboarding solution built by 360Dialog. It is a React.js NPM package that can be embedded into React applications. It allows partners to trigger account creation and 360Dialog-hosted Embedded Signup through intuitive pop-ups.

Ideal for: Partners who prefer a streamlined, no-hassle setup with standard technical involvement. Best for most partners.

✅ Low-code ✅ Fast implementation ✅ Standard user experience

The basic Integrated Onboarding will show:

  1. A 360Dialog-branded Signup Page, where the client will submit their information to create an account

  2. Embedded Signup, where the client will log in their Business Manager account and register their WABA and phone number

  3. Permission screen, where the client will give their partner permission to manage their channels (only required if using Direct Payment)

Using Connect Button

Custom IO

Partners can customize the Integrated Onboarding experience by building their own IO trigger.

Ideal for: Partners with the capability to manage more complex integrations and who prefer to have more control over the signup experience.

✅ Framework-agnostic ✅ More customizable versus the Connect Button ✅ Standard user experience

The custom Integrated Onboarding will show:

  1. A 360Dialog-branded Signup Page, where the client will submit their information to create an account

  2. Embedded Signup, where the client will log in their Business Manager account and register their WABA and phone number

  3. Permission screen, where the client will give you permission to manage their channels (only required if using Direct Payment)

Using Custom IO

Partner-Hosted Embedded Signup

Partners who are approved by Meta as Tech Providers have the option to host their own Embedded Signup.

Ideal for: Partners who want to fully own their sign up experience. Best for the biggest partners.

✅ High-code solution ✅ Fully customizable ✅ Partner hosts the flow

For more information on Tech Providers, and becoming a Tech Provider, refer to the documentation below:

Partner-Hosted Embedded Signup

Standard components

URL/Query Parameters

When triggering Integrated Onboarding, different URL parameters allow you to preselect different settings or customize the flow whenever you need.

Parameter name
Description
Values
Stored in database?
Returned in redirect?

email

User email to pre-fill the signup form

string

Yes, as part of the client setup

No

name

User name to pre-fill the signup form

string

Yes, as part of the client setup

No

number

A specific phone number to request permission for. The number has to match the existing number in the hub. It includes the country code without the leading 00/+.

number

No

No

state

Any string value that shall be passed through and returned with the redirect.

string

Yes

Yes

redirect_url

Will be used as individual redirect URL instead of the globally set one.

string (URL-encoded)

No

Will be used as the new redirect URL

partner

Any string value that shall be stored on the client model. Can be retrieved via API as partner_payload.

string

No

No

next

Can be used to redirect clients directly to either the login form or the signup form, in case they are not yet logged in.

"login" / "signup"

No

No

lang

Can be used to set the default language of the Integrated Onboarding (not including Meta’s ES) Allowed values: de, en

string

No

No

plan_selection

Can be used to set the default pricing plan for the number to be added.

Will only work for partners enabled for tiered pricing. *If you are not sure of you billing plan, please reach out to our Support Team.

Clients on partners with client payment will be able to change the pre-selected plan.

Allowed values: basic, regular, premium

Default: regular.

basic value is only available to partners on the Premium plan.

string

Yes, as part of the number setup

No

connect_client_user

true

string

Yes, as part of the number setup

No

io_signature

Required if IO Signature is enabled. Refer to IO Signature for details.

string

Yes, as part of replay protection

No

io_timestamp

Required if IO Signature is enabled. UNIX timestamp in seconds. Refer to IO Signature for details.

number

No

No

Embedded Signup

Embedded Signup allows customers to log into their Meta account to create new Meta business portfolios, WhatsApp Business Accounts (WABAs), and/or register new phone numbers.

The 360Dialog Embedded Signup is triggered automatically throughout the Integrated Onboarding flow. Partners can host their own Embedded Signup if they wish to, after following specific requirements from Meta.

Webhook Events

When you have a Partner API Webhook URL set, we will send different webhook events that will allow you to understand a status of a signup.

See Webhook events and notifications.

Permission Screen (direct payment only)

If your Partner Hub is set to Partner Payment, you will receive permission to manage the numbers signed up by default. If the setting is Direct Payment, the client will have to give you permission to manage the numbers. See Partner Permissions.

The /permission screen is designed to allow the client (account owner) to share this permission while still in the Integrated Onboarding. Alternatively, the client can grant permissions in their Client Hub settings

To trigger the permission screen, this route needs to be called:

Independently of the development language you’re using, you should be able to use the browser’s open() method of the Window interface. It follows the syntax:

In the specific case this would result for example in the following method:

The permission screen is optimized to be opened in a popup without controls and a size of 600 px (width) by 900 px (height).

Last updated

Was this helpful?