Push conversion events

Forwards a Conversions API event payload to Self Serve as-is, which validates it and manages the dataset for the app.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Sample cURL — Push conversion events.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/conversions/event' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "data" : [ {
    "event_name" : "Purchase",
    "event_time" : 1675999999,
    "action_source" : "business_messaging",
    "messaging_channel" : "whatsapp",
    "user_data" : {
      "whatsapp_business_account_id" : 1234567890,
      "ctwa_clid" : "ARAkLkA8rmlHPSjuaKg8aDLOVF0N0hrgRE83tobzP0AMt3CrDtn5zfRXBbrtDK0c5rU"
    },
    "custom_data" : {
      "currency" : "USD",
      "value" : 123
    }
  } ],
  "partner_agent" : "partner-name"
}'

Sample success response (200)

{
  "events_received": 1,
  "fbtrace_id": "AYZhpp4scrUfVIWcEWJ7NmN",
  "messages": [ ],
  "status": "success"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json