Skip to main content

API Task

Verify quest completion by making a request to an external endpoint. This allows you to create quests with custom tasks tied to your own platform or application.

Request payload

When verifying an API task, our system sends a POST request to the endpoint you specified in the task settings. Each request includes the following data:
Below request payload is sent when the verification is triggered by a quest completion.

Expected response

If the task verification is successful, return a response with a 200 status code. No response body is required, but you can include a verificationData field in the response to store additional, arbitrary metadata about the verification result. This metadata will be saved with the task completion record for future reference.
If the task verification fails, return a response with a 400 status code and include a message field in the response body. This message should explain why the verification failed in a user-friendly way, as it will be displayed to the user in the Flipsuite UI.
Your API endpoint must respond within 30 seconds. If the response takes longer, the task verification will fail with a timeout error.

Endpoint security

In the quest integration settings, you can configure an authentication secret that will be sent with every request to your API. This allows you to verify that the request originated from Flipsuite. The secret is included in the Authorization header of each request.

Quest integration settings