API Callbacks
API integrations use standard Server-to-Server Callbacks to receive real-time notifications for participant outcomes.
For API-based implementations, an additional parameter is included in the callback payload to help reconcile the specific survey result.
Survey Outcome Parameter
For every callback generated via the API, the survey_outcome parameter is included. This value is an integer representing the final status of the participant's session.
| Value | Status | Description |
|---|---|---|
| 1 | Complete | The participant successfully completed the survey. |
| 2 | Disqualified | The participant was screened out based on targeting requirements. |
| 3 | Over Quota | The survey reached its quota while the participant was in progress. |
Important Disclaimer
Callbacks will only be fired for revenue-generating matches.
If a participant is disqualified or the survey reaches its quota, a callback will only be sent if that specific outcome results in a partial reward (as configured in your App Settings). If no revenue is generated for the event, no server-to-server callback will be triggered.
Configuration
To set up or update your callback URL, visit the Edit App section of the Publisher Dashboard.
For details on security, signature validation, and payload structure, refer to the main Callbacks documentation.