Setting Up Callbacks
Get event notifications about clicks, completed video views, or converted installs.
Add a new callback 🔗
- Go to the Callbacks panel in your dashboard.
- Click Add New Callback.
- Name your callback and give it a description.
- Choose a template for your callback.
Using third-party vendors: Chartboost provides preconfigured callback templates for most third-party vendors. Click a template to automatically fill in all the required parameters. You might be prompted to add your bundle ID or other information. All third-party vendors callbacks default to the Advertiser role.
Using your own custom template: If you are not using a defined third-party endpoint, you can select Custom Template and set up your callback using the following settings:
- Role: Select your role (advertiser or publisher). Only select BOTH if you are both publishing and advertising in your app and want to use the same callback for both.
- Tracking URL: The endpoint at your server or third-party tracking service where we’ll be sending the callback (e.g. https://myserver.com/tracker). Our system appends static and dynamic parameters to this URL as specified.
- Static Parameters: Include static key-value pairs in your callback URL’s query string. To include a static parameter like network=chartboost, you’d add network in the Key field and chartboost in Value.
- Dynamic Parameters: Decide what additional information to send about the event. Input the parameter name supported by your endpoint in the Key field, and then select a macro value from the dropdown. You can refer to these parameters for help.
- Callback URL and Ping Test: Click Test Now to verify that your endpoint is healthy. Your callback URL should appear in the field. Here’s an example of what information we send in a test ping:
A Chartboost POST callback does not include data in the body of the request. Instead, it includes the data as a query string appended to the URL, similar to a GET callback.
- Switch your callback from OFF to ON and then click Save.
Attach your callback to your apps or campaigns 🔗
Attaching a callback to your apps 🔗
- Open any callback and scroll down to Select App.
- Checkmark which of your apps will have a click, install, or completed view callback attached to it.
Note that any callbacks created from our predefined third-party vendor templates or using a third-party vendor Tracking URL can only be attached to click or view events.
Install callbacks are only supported with custom templates and custom tracking URLs.
Attaching a callback to your campaigns 🔗
- Open any callback and scroll down to Select Campaign.
- Checkmark which of your campaigns will have a click, install, or completed view callback attached.
Note that any callbacks created from our predefined third-party vendor templates or using a third-party vendor Tracking URL can only be attached to click or view events.
Install callbacks are only supported with custom templates and custom tracking URLs.
- Callbacks with Advertiser Role will not display Network Publishing campaigns within the Select Campaign window and will also not be selectable on the Network Publishing campaign pages.
- Callbacks with Publisher Role will not display Network Advertising campaigns within the Select Campaign window and will also not be selectable on the Network Advertising campaign pages.
If the app associated with this campaign already has this callback attached to the same event, you don’t need to attach this callback to the campaign.
- Attaching a callback to your entire account: To simplify the Callback feature on the Chartboost dashboard, we removed the ability to attach callbacks to the Account-level as of October 7th, 2020.
If you have any questions about this change please contact our Support Team.
Request server-to-server (S2S) tracking 🔗
- If want to use server-to-server (S2S) tracking, you need to manually request activation from your account manager. If you don’t need S2S tracking, you can skip this step.
- In order for Chartboost to enable S2S tracking, you must deposit at least $5,000 into your advertising balance. Add more money to your balance
- Learn more about server-to-server (S2S) tracking
Copy and edit your callbacks for different apps or campaigns 🔗
- To copy a callback, open it and click Duplicate at the top of the page.
- Click X to delete a callback from your list.
- Click the pencil icon to edit a callback.
- Click the pause icon to pause a callback.
Callbacks policies you should know about 🔗
- You’ll need a server that’s ready to support real-time events.
- We make three attempts to deliver callbacks to your server. If all attempts fail, your endpoint will be blacklisted for 15 minutes. During blacklistings, the callbacks will not be sent or attempted until the full time has elapsed.
- Our service deems a request successful if your server responds 2xx.
- Callbacks can be a redirect URL, but cannot have any store (App Store, Google Play Store, Amazon Appstore for Android, etc.) as a final destination. They must also be valid URLs. For the most reliability, do not use redirects.
- The endpoint must support SSL via HTTPS.
- All data is URL-encoded before being sent.