API Access

Firstly to complete the integration with your platform you will need to set up permissions and access keys

  1. Create an access policy or multiple policies. To onboard a customer at a minimum this should cover the following permissions:

Description

Action

Resource

Add WhatsApp tech provider information to your organization

Create

/organizations/{{orgId}}/platforms/whatsapp/actions/setupTechProvider

Create customer workspaces

Create

/organizations/{{orgId}}/workspaces

List customer phone numbers

View

/workspaces/*/numbers

Find a phone number

View

/workspaces/*/numbers-available

Buy a phone number

Create

/workspaces/*/numbers

List phone numbers

View

/workspaces/*/numbers-long-code

Create a connector

Create

/workspaces/*/connectors

Create a webhook subscription

Create

/organizations/{{orgId}}/workspaces/*/webhook-subscriptions

Note: Replace {{orgId}} with your organization id. The wildcard (*) means access to any resource e.g. all workspaces. If you want to create a policy for a specific resource, replace the wildcard with the specific resource UUID (e.g. workspace id)

To find your organisation id go to Settings>Account>Organization

  1. Once you have created an access policy you will need to attach this to access role

  2. Finally you will need to create a new access key and attach the role to it

  3. To create and manage access keys programmatically you can see more here

pageAssociating your Facebook solution ID and business ID with your Bird CRM Organization

Last updated