Yazi docs
  • Setting up the WhatsApp API number
    • Setting up WhatsApp number in Yazi platform
      • Add a Payment Method
      • WhatsApp Profile
      • Get your business manager verified
      • Developer Portal method of setting up
  • Using Yazi's app
    • Research Campaign Setup
      • Survey Campaign
      • Diary Study Campaign
      • AI Interview Campaign
        • AI Interview Prompt Template
    • Inviting Participants
      • Sharing Links to access research
      • Create Template message
      • Send template message
      • Template Message history/stats
    • Results
      • Interviewer Results
      • Survey Results
  • APIs & Integrations
    • Setting up event-triggers
  • WhatsApp API Pricing
    • Pricing
  • Security
    • Data Security - Executive Summary
    • Yazi Information Security Policy
    • Data Classification Policy
    • Yazi Security and Data Management Policies
    • Yazi Vendor Management Policy
    • Data Retention Policy
    • Business Continuity Plan (BCP)
  • Yazi Process
    • 🎳Quality Control Plan for Yazi Research (Pty) Ltd
Powered by GitBook
On this page
  • 1. Setup Developer Portal
  • 1.2 Create WhatsApp product
  • 2. API Setup
  • 2.1 Add phone number
  • META BUSINESS MANAGER
  • 4. System User token
  • META FOR DEVELOPERS
  • 5. Copy Phone number ID and WhatsApp Business Account ID
  • 6. Toggle App Mode onto Live
  • Additional profile check
  1. Setting up the WhatsApp API number
  2. Setting up WhatsApp number in Yazi platform

Developer Portal method of setting up

PreviousGet your business manager verifiedNextResearch Campaign Setup

Last updated 2 days ago

Step by Step Summary

  1. Get your Business manager verified and set up a new app in the

  2. Add WhatsApp as a product in your new app in Developers portal

  3. Setup a number in section 5 of “API Setup” in the

  4. Add configuration keys - Callback URL and Verify token in the

  5. In the “Webhook fields” section directly below, press the “Manage” button and click ALL the tickboxes in “Subscribe” column

  6. Add payment method in

  7. Generate System User token i. In , create an Asset with “Manage App” under Full control

    ii. Generate token - Select “Never” for token expiration and tick the following boxes

    1. Business Management

    2. WhatsApp business messaging

    3. WhatsApp Business management

    iii. Copy token and send it to Yazi

  8. Copy the Phone number ID and WhatsApp Business Account ID in in the developers Portal and send it to Yazi

  9. Toggle Developer mode to be on Live

1. Setup Developer Portal

1.1 Create an app

  1. Select “Other” for “What do you want the app to do?”

  2. Select “Business” for “Select an app type”

  3. Give your app a name, add a contact email and associate it with a Meta Business Manager

1.2 Create WhatsApp product

  1. Click “Add Product”

  2. Scroll down to WhatsApp and click “Set Up”

  3. Press “Continue” in Quick start

2. API Setup

2.1 Add phone number

  • Make sure you have the number ready to receive SMS or phone call

  • After adding your number, you might need to refresh the page if the number isn’t showing up

2.2 Setup Webhook

  1. Enter the Callback URL and Verify token (both of these keys will be provided to you by Yazi)

  2. Press the “Verify and Save” button (it will do a pink test and automatically save)

In the “Webhook fields” section directly below, press the “Manage” button

  • Click ALL TICKBOXES in the Subscribe column. This allows us to track and retrieve the data so make sure to tick every one!

4. System User token

You have now entered the identification that WhatsApp needs from our software system. Now, for our system to connect to your number, we need 3 items or identifiers from you. These are:

  1. System User token

  2. Phone number ID

  3. WhatsApp Business Account ID

4.1 Add System User if none existed

Go to Users and click on “System Users” (you need to be an Admin user to do this)

Note:

  • If no System user exists, Press the “Add” button → Set system user role to Admin

  • Difference between the system user and regular user. System user doesn’t require a reset of the token after it expires because the system can be set up as permanent. If the system is compromised then you can revoke

4.2 Add Asset

Click “Add Assets” and a Modal will pop up. Navigate the following:

  1. Click the “Apps” page

  2. Select the app you just created

  3. Toggle “Manage App” under Full control to be on

  4. Press the “Save changes” button

4.3 Generate Token

  1. Click “Generate New Token”

  2. Select your App

  3. Select “Never” for token expiration

Tick the following boxes

  • Business Management

  • WhatsApp business messaging

  • WhatsApp Business management

When you've done this, Click the “Generate Token” button

Notes

  • This is the identifier that will be sent back to Yazi to configure the system to your personal account.

  • Once the code is generated, you can send it to Yazi to complete the configuration of your account Selecting Never for Token expiration means you don’t have to keep configuring new tokens

4.4 Access Token via Debugger

  1. Click “Debug” on the app you just created

  2. Copy the Debug code

Note: Also see all the information about the token

5. Copy Phone number ID and WhatsApp Business Account ID

  1. Phone number ID

  2. WhatsApp Business Account ID

  3. The actual WhatsApp number

Send these back to Yazi along with the System token

6. Toggle App Mode onto Live

Toggle the app to “Live”. As this is approved, you will normally be upgraded to be able to send 1,000 Template messages per day (1,000 outbound notification messages per 24 hours)

Might take a day to populate.

Additional profile check

  1. Check the status of your number Should take 1-2 business days to be approved

  2. Profile Add description Picture

Go to and click “Create App”

Click on “Add phone number” button in “”. Fill out your profile name and add the number: a) Add profile display name prescribed by Meta. Make sure it’s associated with your business’s actual name. If it is not associated, Meta is likely to reject it. For Research bots, we typically advise [business_name] + Research as your Display Name. See article for more details. b) Choose a category and business Description c) Add number: Select country code and add a number to receive OTP via SMS or phone call to verify

Go to the and press the “Edit” button in the webhook card section

Head back to to generate a system token from someone who is a System user:

To copy or access the information about the token: Go to Access token page in Tools in the Facebook Developers portal

Go back to in the developers PortalCopy the following:

Note: You may need to add your Privacy policy in to be able to do this.

META FOR DEVELOPERS
Meta for Developers
Step 5: Add a phone number section
Display Name Guidelines
Configuration section
META BUSINESS MANAGER
Business Manager
META FOR DEVELOPERS
https://developers.facebook.com/tools/accesstoken/
API setup
Basic Settings
Developer portal
developers portal
Configuration section
Meta Business Manager
Business Manager
API setup
Step 1
Step 2
Step 3