-
Go to Aidem Ads.
-
In the left-hand side menu section select “Integrations”.
-
In the newly opened window in the top right corner click “New Integration”.
-
Afterwards you should see the new integration dialog where you should enter the following setup options:
-
Integration name – unique name to help your team identify the integration.
-
Advertiser selection – advertiser under which this integration should be implemented.
-
Integration - please select Conversion API.
-
-
After all the data is entered please click “Next” button.
-
In the next step you should be able to see the Aidem Conversion API Authorization token, either copy the token from the textarea or click “Copy to Clipboard” button.
-
Use the above mentioned token as Authorization Bearer Token header when sending requests to Aidem.
-
Create JSON payload with all the information which you would like to pass. Here is a list of required fields:
a) timestamp - utc timestamp.
b) event_type - specific event type (supported event types can be found below).
c) payload.email - customer email address.{ "timestamp": UTC_TIMESTAMP_GOES_HERE, "event_type": "EVENT_TYPE_GOES_HERE", "payload": { "email": "EMAIL_GOES_HERE", "first_name": "FIRST_NAME_GOES_HERE", "last_name": "LAST_NAME_GOES_HERE", "phone_number": "PHONE_NUMBER_GOES_HERE", "address": { "address_line_1": "ADDRESS_LINE_1_GOES_HERE", "address_line_2": "ADDRESS_LINE_2_GOES_HERE", "city": "CITY_GOES_HERE", "state": "STATE_GOES_HERE", "zip": "ZIP_GOES_HERE", "country": "COUNTRY_GOES_HERE" }, "order_id": "ORDER_ID_GOES_HERE", "currency": "CURRENCY_GOES_HERE", "price": PRICE_GOES_HERE, "units": UNITS_GOES_HERE } }
-
It is very important to notice that the majority of payload fields are optional, however passing as many of them as possible greatly increases the conversion match rate, so we highly recommend to pass as much information.
-
After the JSON is created and all the fields are filled in with the necessary information it can be sent to our server using POST HTTP method to the following endpoint: https://webhook.aidemsrv.com/conversion/api.
Example
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer YOUR_TOKEN_CREATED_IN_STEP_6_GOES_HERE" \
--request POST \
--data '{"timestamp":1752667603,"event_type":"Purchase","payload":{"email":"test@aidem.com","first_name":"Aidem","last_name":"Ads","phone_number":"+1 (415) 555-0198","address":{"address_line_1":"1234 Elm Street","address_line_2":"","city":"San Francisco","state":"CA","zip":"94107","country":"USA"},"order_id":"123456","currency":"USD","price":100,"units":2}}' \
https://webhook.aidemsrv.com/conversion/api
Supported Event Types
Event Type | Description |
---|---|
PageView | A visit to a any page on your website. |
AddPaymentInfo | The addition of customer payment information during a checkout process. |
AddToCart | The addition of an item to a shopping cart or basket. |
AddToWishlist | The addition of items to a wishlist. |
CompleteRegistration | A submission of information by a customer in exchange for a service provided by your business. |
Contact | A telephone, SMS, email, chat or other type of contact between a customer and your business. |
CustomEvent | Any other event that is of interest. |
CustomizeProduct | The customization of products through a configuration tool or other application. |
ConfiguratorCompletion | Completion of the carline configuration |
Donate | The donation of funds to your organisation or cause. |
DonateRecurring | Recurring donation funds to your organization or cause. |
FindLocation | When a person finds one of your locations via web, with an intention to visit. |
InitiateCheckout | The start of a checkout process. |
Lead | A submission of information by a customer with the understanding that they may be contacted at a later date. |
Purchase | The completion of a purchase. |
Schedule | The booking of an appointment to visit one of your locations. |
Search | A search performed on your website, app or other property. |
StartTrial | The start of a free trial of a product or service you offer. |
SubmitApplication | The submission of an application for a product, service or programme that you offer. |
Subscribe | The start of a paid subscription for a product or service you offer. |
ViewContent | A visit to a web page you care about. |
CoverageCheck | A submission of information by a customer to check service coverage. |
CallMeBack | A call back request by a customer with the understanding that they may be contacted by your business. |
ClickToCall | A customer initiated telephone, SMS, email, chat or other type of contact between a customer and your business. |
DownloadBrochure | The download of a pdf. brochure. |
TestDriveRequest | The request for a trial of a car. |
DealerLookup | The search for a car dealer. |