Authorization
 2.1.0 
OAS 3.0

WhatsApp Connector by Respira Authentication


Before using this API

In order to be able to use this API, you must first complete the Installation Procedure .

This API will require you to have a Zendesk Suite Professional or Enterprise license. Contact us if you would like to learn more about getting or upgrading to Zendesk Suite Professional or Enterprise.


Authorizing requests

The method available for user authorization is basic authorization. If you followed the installation procedure above, now you have:

  • An active admin account with the WhatsApp Connector App by Respira.
  • An active connection, with an API key, and all the settings necessary for WhatsApp Proactive message delivery.

Your API requests, must include a Base64 encoded Basic Authorization header, generated using the following credentials:

  • Username: {{admin_user_email}}/token (string "/token", not an API token value). Username example: my-email@my-domain.com/token
  • Password: {{respira_connection_api_key}}. Check out the WCR installation procedure to find out how to get your Respira Connection API Key.

Some things to keep in mind

  • The {{respira_connection_api_key}} variable must be active.
  • The user linked to that connection must be the same as defined by the admin user in the username.
  • This API does not send free text. It is intended for the sole purpose of sending proactive WhatsApp Notifications.


Zendesk WhatsApp Connector API

  • Authorization
    • Authorization Information
  • WhatsApp Messages
    • Sending and querying messages

  Download Postman Collection