GUgupshup
Conversions

Push conversion events to Meta

Push conversion events for a WhatsApp app via the dataset associated with its WABA.

post/app/{appId}/conversions/event

Request

  • Base URL
    https://partner.gupshup.io/partner
  • URL
    https://partner.gupshup.io/partner/app/{appId}/conversions/event
  • Auth
    HTTP bearer

Path parameters

appIdstring required

Partner / WhatsApp app id. The app must belong to the authenticated partner.

Request body

partner_agentstring required

Partner / agent name.

Example request

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "whatsapp",
      "user_data": {
        "ctwa_clid": "ARBcDeFgHiJkLmNoPqRsTuVwXyZ"
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "gupshup"
}

Response

Upstream success

events_receivedinteger
fbtrace_idstring
messagesstring[]
statusstring

Example response

{
  "events_received": 1,
  "fbtrace_id": "AYZhpp4scrUfVIWcEWJ7NmN",
  "messages": [],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.