Account restriction webhook

Subscribe to account_update and listen for event = ACCOUNT_RESTRICTION.

Relevant violation_type values:

DIRECT_SEND_UTILITY_TEMPLATE_ABUSE_WARN
DIRECT_SEND_UTILITY_TEMPLATE_ABUSE_RATE_LIMIT
DIRECT_SEND_UTILITY_TEMPLATE_ABUSE_STRIKE_1
DIRECT_SEND_UTILITY_TEMPLATE_ABUSE_STRIKE_2
DIRECT_SEND_UTILITY_TEMPLATE_ABUSE_OFFBOARD
DIRECT_SEND_AUTHENTICATION_TEMPLATE_ABUSE
DIRECT_SEND_UTILITY_CATEGORY_ABUSE_RATE_LIMIT

Warning strike payload

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "ACCOUNT_RESTRICTION",
            "violation_info": {
              "violation_type": "DIRECT_SEND_UTILITY_CATEGORY_ABUSE_WARN"
            }
          },
          "field": "account_update"
        }
      ]
    }
  ]
}

Rate-limit / ban payload

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "ACCOUNT_RESTRICTION",
            "violation_info": {
              "violation_type": "DIRECT_SEND_UTILITY_CATEGORY_ABUSE_RATE_LIMIT"
              // or STRIKE_1 / STRIKE_2 / OFFBOARD
            },
            "restriction_info": {
              "restriction_type": "RESTRICTED_DIRECT_SEND_UTILITY_TEMPLATES",
              "expiration": <expiration_timestamp>
            }
          },
          "field": "account_update"
        }
      ]
    }
  ]
}

Restriction lifted payload

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
      "time": TIMESTAMP,
      "changes": [
        {
          "value": {
            "event": "ACCOUNT_RESTRICTION",
            "violation_info": {
              "violation_type": "DIRECT_SEND_UTILITY_CATEGORY_ABUSE_UNBAN"
              // or ..._RATE_LIMIT_RECOVERY
            }
          },
          "field": "account_update"
        }
      ]
    }
  ]
}

Updated 15 days ago

Did this page help you?