Fetch WhatsApp plugin configuration

GET

https://api.chakrahq.com/v1/ext/plugin/whatsapp/{pluginId}/config

You can use this API to fetch plugin configuration. This is useful for example when you are using the connected partner embedded signup and want to fetch the configuration of the end client plugins.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.chakrahq.com/v1/ext/plugin/whatsapp//config' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "_data": {
    "passThroughWebhookUrl": "http://localhost:3099/log",
    "enableMessageEchoesForPassThroughWebhook": true,
    "enableSendMessageTemplateEventForPassThroughWebhook": true,
    "enableChakraWebhook": true,
    "chakraWebhookUrl": "http://localhost:3099/log",
    "whichChakraWebhookEventsToSend": [
      "message",
      "status",
      "message_echo",
      "smb_message_echo"
    ],
    "whatsappBusinessAccounts": [
      {
        "id": "973055385119463",
        "name": "Sandbox WhatsApp Business Account",
        "timezone_id": "1",
        "account_review_status": "APPROVED",
        "business_verification_status": "not_verified"
      }
    ],
    "whatsappPhoneNumbers": [
      {
        "id": "1027729340496751",
        "status": "CONNECTED",
        "throughput": {
          "level": "STANDARD"
        },
        "account_mode": "LIVE",
        "is_on_biz_app": false,
        "platform_type": "CLOUD_API",
        "verified_name": "Test Number",
        "display_phone_number": "+1 555-191-4348",
        "official_business_account": {
          "oba_status": "NOT_STARTED"
        },
        "is_official_business_account": false
      }
    ]
  }
}

Modified at 2026-04-28 07:55:50

Update WhatsApp plugin configuration

Disconnect WABA Account