API Reference
Actions Reference
- POSTCreate Campaign
- POSTUpdate Campaign
- POSTGet Campaign By ID
- POSTGet Campaigns
- POSTCreate Ad Set
- POSTUpdate Ad Set
- POSTGet Ad Set By ID
- POSTGet Ad Sets
- POSTCreate Ad
- POSTUpdate Ad
- POSTGet Ad By ID
- POSTBuild Ad Creative Object
- POSTCreate Ad Creative
- POSTCreate Lead Gen Form
- POSTSend Purchase Event
- POSTSend Lead Event
- POSTSend Funnel Event
- POST
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#FACEBOOK_ADS_SEND_LEAD_EVENT' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "FACEBOOK_ADS_SEND_LEAD_EVENT",
"parameters": {
"actionSource": "website",
"pixel": "<string>",
"eventTime": "<string>",
"eventId": "<string>",
"eventSourceUrl": "<string>",
"customerEmail": "<string>",
"customerFirstName": "<string>",
"customerLastName": "<string>",
"customerCity": "<string>",
"customerState": "<string>",
"customerCountryCode": "<string>",
"customerExternalId": "<string>",
"customerClientIpAddress": "<string>",
"customerClientUserAgent": "<string>",
"clickId": "<string>",
"browserId": "<string>",
"contentId": "<string>",
"contentName": "<string>",
"contentCategory": "<string>"
}
}
'Send Lead Event
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#FACEBOOK_ADS_SEND_LEAD_EVENT' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "FACEBOOK_ADS_SEND_LEAD_EVENT",
"parameters": {
"actionSource": "website",
"pixel": "<string>",
"eventTime": "<string>",
"eventId": "<string>",
"eventSourceUrl": "<string>",
"customerEmail": "<string>",
"customerFirstName": "<string>",
"customerLastName": "<string>",
"customerCity": "<string>",
"customerState": "<string>",
"customerCountryCode": "<string>",
"customerExternalId": "<string>",
"customerClientIpAddress": "<string>",
"customerClientUserAgent": "<string>",
"clickId": "<string>",
"browserId": "<string>",
"contentId": "<string>",
"contentName": "<string>",
"contentCategory": "<string>"
}
}
'Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
Show child attributes
Show child attributes
Action Source
website, chat, app, email, phone_call, system_generated, other The Facebook Pixel that will receive the event
Event Time : Time when the event occurred (ISO 8601 timestamp). Defaults to the time of the workflow execution if left blank (example: "2020-03-31T12:02:00Z")
Event ID : Used to remove duplicates when sending the same event from more than one source.
Event Source URL : The URL where the event occurred. Required if the Action Source is Website.
Customer Email : The email of the customer associated with the event, so they can be matched to a Facebook account and used for ads attribution and delivery optimization.
Customer first name
Customer last name
Customer city
Customer state
Customer country code
Customer External ID : A custom ID for the prospect, often referencing an ID in an external system.
Customer client IP address : The IP address of the browser corresponding to the event.
Customer client user agent : The user agent for the browser corresponding to the event.
Click ID (fbc) : The Facebook click ID value stored in the _fbc browser cookie.
Browser ID (fbc) : The Facebook browser ID value stored in the _fbp browser cookie.
Content ID : The content IDs associated with the event, such as product SKUs for items in an AddToCart event. Accepts an array of IDs. (example: "['ABC123', 'XYZ789']")
Content Name : The name of the page or product associated with the event. (example: "Lettuce")
Content Category : The category of the content associated with the event. (example: "Grocery")
Response
Success
Was this page helpful?