Skip to content

Commit 6484169

Browse files
overview page for whatsapp adaptor (#702)
* overview page for whatsapp adaptor * Changed the property name for the bearer token to reflect what is in the config schema * Changed the link to the correct WhatsApp business API page --------- Co-authored-by: Pius Kariuki <[email protected]>
1 parent 6830ca1 commit 6484169

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

adaptors/whatsapp.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: WhatsApp Adaptor
3+
---
4+
5+
## About WhatsApp
6+
7+
The [WhatsApp Business Platform](https://developers.facebook.com/docs/whatsapp) enables organizations to communicate with their customers on WhatsApp at scale. It supports sending messages, notifications, and media, as well as receiving inbound customer messages through a secure and reliable API.
8+
9+
This adaptor allows OpenFn users to integrate workflows with WhatsApp Business Cloud or On-Premise APIs to send and receive WhatsApp messages as part of automated processes.
10+
11+
## Integration Options
12+
13+
The WhatsApp Business API provides a [REST API](https://developers.facebook.com/docs/whatsapp) to manage message sending, conversations, and contacts. See [functions](/adaptors/packages/whatsapp-docs) for examples of how to use this adaptor to call the API.
14+
15+
In addition, WhatsApp Business supports [Webhooks](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/payload-examples) that deliver inbound messages and delivery status updates in real time. These can be consumed by OpenFn workflows via a [webhook event trigger](/documentation/build/triggers#webhook-event-triggers) when customers send messages.
16+
17+
## Authentication
18+
Access to the WhatsApp Business API requires a `Permanent Access Token` (for Cloud API) or a generated `Bearer Token` (for On-Premise deployments). This token must be included as an Authorization Bearer Token in all requests.
19+
20+
For Cloud API, you must also specify your `phone_number_id` and `whatsapp_business_account_id`.
21+
[See Meta WhatsApp Business docs](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started) for detailed guidance.
22+
23+
OpenFn users can use the `whatsapp` credential type when [creating a credential](/documentation/manage-projects/manage-credentials) on the app.
24+
25+
If working locally or if using a `Raw JSON` credential type in OpenFn, your configuration will look something like this ([see configuration docs](/adaptors/packages/whatsapp-configuration-schema)):
26+
27+
```json
28+
{
29+
"baseUrl": "https://graph.facebook.com/v21.0",
30+
"apiToken": "EAAJZC...your_long_lived_access_token",
31+
"phoneNumberId": "123456789012345",
32+
"wabaId": "987654321098765"
33+
}
34+
35+
```
36+
37+
## Helpful Links
38+
39+
- WhatsApp Business API documentation: https://developers.facebook.com/docs/whatsapp
40+
- Cloud API Get Started guide: https://developers.facebook.com/docs/whatsapp/cloud-api/get-started
41+
- Webhook payload examples: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/payload-examples

0 commit comments

Comments
 (0)