Subscribe app to WABA webhook events

POST/v1/waba/subscribe-webhook

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

phone_number_idstringrequired

Phone number ID from Meta

min length 1

progress_idstringrequired

Integration progress ID

min length 1

waba_idstringrequired

WABA ID from Meta

min length 1

Responses

200OK

channel_idstring | nullrequired

completed_stepsanyrequired

created_atstringrequired

current_stepstringrequired

errorstring | nullrequired

idstringrequired

organization_idstringrequired

phone_number_idstring | nullrequired

step_statusstringrequired

updated_atstringrequired

waba_idstring | nullrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/waba/subscribe-webhook" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number_id": "string",
  "progress_id": "string",
  "waba_id": "string"
}'

const response = await fetch("/v1/waba/subscribe-webhook", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "phone_number_id": "string",
  "progress_id": "string",
  "waba_id": "string"
})
});

import requests

response = requests.post(
    "/v1/waba/subscribe-webhook",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "phone_number_id": "string",
  "progress_id": "string",
  "waba_id": "string"
},
)

Response

{
  "channel_id": "string",
  "completed_steps": "string",
  "created_at": "string",
  "current_step": "string",
  "error": "string",
  "id": "string",
  "organization_id": "string",
  "phone_number_id": "string",
  "step_status": "string",
  "updated_at": "string",
  "waba_id": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}