Sign in
OpenAPI 3.1.02026-08-143874115.7 MB

a84d4905fdbb

Ad Campaigns

Ad Campaign Payment failed

Sent when an ad campaign's payment fails and its ads stop delivering

Required permissions:

  • webhook_receive:ad_campaigns
postWebhookad_campaign.payment_failed

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'ad_campaign.payment_failed' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "added_to_cart_value": 12650,
    "added_to_carts": 165,
    "bid_type": "average_target",
    "budget_amount": 50,
    "budget_optimization": "ad_group",
    "budget_type": "daily",
    "click_through_rate": 0.025,
    "clicks": 5500,
    "completed_registration_value": 1650,
    "completed_registrations": 55,
    "contact_value": 2640,
    "contacts": 88,
    "cost_per_added_to_cart": 8,
    "cost_per_click": 0.24,
    "cost_per_completed_registration": 24,
    "cost_per_contact": 15,
    "cost_per_lead": 10,
    "cost_per_mille": 6,
    "cost_per_purchase": 30,
    "cost_per_result": 40,
    "cost_per_schedule": 22,
    "cost_per_submitted_application": 120,
    "cost_per_unique_click": 0.4,
    "cost_per_viewed_content": 1.1,
    "created_at": "2026-01-01T12:00:00.000Z",
    "custom_conversions": 41,
    "custom_event_counts": {
      "gift_card_purchased": 5,
      "quote_requested": 33
    },
    "custom_event_values": {
      "gift_card_purchased": 750,
      "quote_requested": 0
    },
    "delivery_status": "issues",
    "id": "adcamp_xxxxxxxxxxxxxx",
    "impressions": 220000,
    "issues": [
      {
        "id": "adiss_xxxxxxxxxxxxxx",
        "message": "Your ad was rejected for unacceptable business practices. Edit the ad's content and resubmit.",
        "resource_id": "ad_xxxxxxxxxxxxxx",
        "resource_type": "ad"
      }
    ],
    "lead_value": 3960,
    "leads": 132,
    "objective": "leads",
    "platform": "meta",
    "purchase_value": 7920,
    "purchases": 44,
    "result_event": "custom",
    "result_event_name": "quote_requested",
    "results": 33,
    "return_on_ad_spend": 6,
    "schedule_value": 5400,
    "schedules": 60,
    "special_ad_categories": [
      "employment"
    ],
    "spend": 1320,
    "spend_currency": "usd",
    "status": "active",
    "submitted_application_value": 1320,
    "submitted_applications": 11,
    "title": "Ceramic coating — Austin leads",
    "unique_clicks": 3300,
    "updated_at": "2026-01-01T12:00:00.000Z",
    "viewed_content_value": 8400,
    "viewed_contents": 1200
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "ad_campaign.payment_failed"
}

Response

Return a 200 status to indicate that the data was received successfully