Setting Up Callbacks

Get event notifications about clicks, completed video views, or converted installs.
  • Click Add New Callback.
  • Name your callback and give it a description.
  • Select your role (advertiser or publisher). Only select BOTH if you are both publishing and advertising in your app and need callbacks for both roles.
  • 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.
  • 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:
  • 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:
{
    "from" : "TestPublisherGame",
    "uuid" : "5555555555555555",
    "campaign" : "TestCampaign",
    "campaign_id" : "444444444444444444444444",
    "to" : "TestAdvertiserGame",
    "ifa" : "66666666666666666666666666666666",
    "type" : "click"
}
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.
▲ Back to top

  • Attaching a callback to your apps: Open any callback from your list and scroll down to Select App. Checkmark which of your apps will have a click, install, or completed view callback attached to it. Alternatively, select any app from the top left of your dashboard, go to its Basic Settings > Advanced Settings, and attach callbacks from the dropdowns there (see screenshot below).
  • Attaching a callback to your campaigns: Open any callback from your list and scroll down to Select Campaign. Checkmark which of your campaigns will have a click, install, or completed view callback attached. Alternatively, open any of your advertising or publishing campaigns, go to the campaign’s advanced settings, and attach callbacks from the dropdowns there (see screenshot below).
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 will be removing the ability to attach callbacks to the Account-level.

    • While Account-level callbacks are currently available under ‘Tools > Callbacks’, this setting will be removed by October 7th, 2020.

    • If you have active Account-Level callbacks set up in your Chartboost dashboard and you wish to keep these callbacks active:

      Go to ‘Tools > Callbacks > Editand set the callback by either App or Campaign and check the relevant boxes for Click or View.

      Important to note:

      • When setting callbacks by App or Campaign select either Click or View. Do not select ‘Install’ event type as this will be deprecated in the near future.

      • Each app and campaign can only have one callback attached. If there is an existing callback attached you will see it listed under ‘Existing Callbacks’, see screenshot below. Review your callbacks settings prior to re-applying callbacks to apps or campaigns.

Any existing Account-level callbacks will be turned off on October 7th, 2020. This removal without any actions from your side will not affect your performance with us. Therefore unless you actively use any callback data coming from us there is no action needed.

If you have any questions about this change please contact our Support Team.
▲ Back to top

▲ Back to top

  • 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.
▲ Back to top

  • 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.
▲ Back to top

You might also like…