Step 2: Create Onboarding link
Create WhatsApp onboarding link account
Please read carefully the following steps on how the onboarding works
This API allows you to create a WhatsApp account from a registered number (Step 1: Register a number). You will provide the registered number you want to onboard and this number should be verified in your account first. once you add and verify the number, you can create an account.
Next, the system will generate onboarding link. the onboarding link should be shared with your client / customer. the link should be shared with the business owner.
Once the client opens the onboarding link, and follow Facebook onboarding process, this will create WhatsApp account for him. after the client opens the link, this is what he will be facing:
The client is asked to login to his Facebook account. if his browser is already logged in, it will auto recognize it. if the client doesn't have a Facebook account, the onboarding will create an account for him.
The client is asked to provide his business details (business name, business email) if the client already have a business on Facebook, he can select the business. if the client doesn't have a business, the onboarding will create one for him. If you know details about your customer's business, such as its name and email address, you can inject this data into onboarding screen. This can dramatically reduce the amount of input and interaction required by your customers.
The client might be asked to create "WhatsApp" account. he can choose the name for his WhatsApp (for reference purposes only) and the timezone. (this page only shows if the client had a business on Facebook already)
Submit. the client click "Confirm" button and the page closes itself. the process is completed and the client can start using WhatsApp right away.
You will get a webhook once the client completed the process, and the WhatsApp account will be active usually immediately to receive messages.
It might take few hours from Facebook side to confirm the account (verify authenticity). Once its confirmed, you will be able to send Templates and messages.
You can generate only 1 onboarding link per registered number. You cant change the onboarding information once the link has been created. if you wish to change the information, you must delete the onboarding link first and then create a new one. once the onboarding link is completed by the client, you cant change the information or delete the onboarding link anymore.
Important notice: when creating a business profile on Facebook using the onboarding link, Facebook also ask for a landing page of the business (business website). Our system will automatically generate a landing page for you if you provide business_name, business_address and business_id. Facebook has a very strict rules on how the company website should be, the landing page we generate fit their rules. this landing page is not visible to the end users, and its only for reference purposes of Facebook.
The above notice isn't relevant if the client already have a business on Facebook.
Settings:
URL | |
Method | JSON via POST |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example | Maximum length | Mandatory |
|---|---|---|---|
For a new WhatsApp, here is where you put the registered and verified number from your account (from Step 1) If you want to use coexistence feature, put here 1 as the whatsapp parameter. | Yes | ||
business_name | This is the official business name of your client letters, numbers and hyphen are allowed | 100 | Yes |
business_email | This is the business email address. provide this value if you wish to help client to create a business profile on Facebook in case he doesn't have one. | 200 | No |
business_id | This is the ID of the business. provide this value if you wish to help client to create a business profile on Facebook in case he doesn't have one. numbers only | 20 | No |
business_address | This is the home/office address of the business. provide this value if you wish to help client to create a business profile on Facebook in case he doesn't have one. provide here the full address of the business in free text. | 300 | No |
display_name | The WhatsApp display name that the clients will use on WhatsApp. this is very important to choose the right name that matches the business brand name. For example, for a business name "Pizza Hut". the display name should be something similar to: "Pizza Hut" / "Pizza Hut - Customer Service" / "Pizza Hut - support" etc. This value can not be changed later, only via our support. letters, numbers and hyphen are allowed. | 50 | Yes |
onboarding_logo | The onboarding link contains a logo image. Inside the Settings->Onboarding API you can set your default onboarding links logo. Here, you can set a specific https url link for a different logo for this link. this will override the account onboarding logo from Settings->Onboarding API. The image size should be 200x60 px with png/jpg format | 1000 | No |
onboarding_message | The onboarding link contains a welcome text before the client starts the onboarding. Inside the Settings->Onboarding API you can set your default onboarding message text. Here, you can set a specific welcome text for this link. this will override the account onboarding text from Settings->Onboarding API Any letters , numbers and dash is acceptable | 200 | No |
reference | Any reference value (text/numbers only) you wish to receive back on the webhook. this is for your use only so you can recognize your client | 50 | No |
basic_templates | After your client finishes the onboarding, we can send for approval 3 Hebrew default basic templates for you: start a conversation template, welcome template and send a file template so it will be easier to start sending templates later on. default is off. 1 - to create the 3 Hebrew basic templates 0 - don't create | 1 | No |
Response:
{
"status": "OK",
"whatsapp": "972771234567",
"onboarding_link": "https://onboarding.direct/123456",
"landing_page": "https://landingpage.com/123456",
"reason": 1
}Response-Explain:
Parameter | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request has been sent to Meta. "Fail" means error. | ||||||||||||||||||||||||||
The whatsapp number you provided. if this is "coexistence" onboarding, you will see the temporarily number we allocated to this onboarding until the client finishes the onboarding process to get a final whatsapp number. | |||||||||||||||||||||||||||
onboarding_link | The onboarding link to share with your client to connect the WhatsApp | ||||||||||||||||||||||||||
landing_page | The landing page we created for your customer. you can share this with him | ||||||||||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|