The API Reference is an interactive feature on event definition level that allows you to not only view sample data but also input your own data and directly send an event to the endpoint.
For development purposes we also have the option to copy the URL and body as cURL, this does require a product token, which you can create in the settings - API credentials tab.
Viewing the API Reference
-
What does it show?
-
Endpoint URL: The address where you can send the event.
-
Sample JSON Body: A sample JSON body generated based on the event definition.
-
Modifying the JSON Body
-
Input your own data:
-
Use the clear values button to remove the sample values
-
Click on the JSON body to edit it.
-
Fill in the fields with your own data.
-
You can fully customize the JSON body to suit your needs.
-
-
Reset to initial data:
-
Use the Reset button to restore the JSON body to its original, auto-generated sample data.
-
Sending an Event
-
How does it work?
-
Fill in the JSON body with the appropriate data.
-
Click the Send Event button to send the event to the endpoint.
-
Feedback
-
After sending an event, you will receive immediate feedback:
-
Success message: If the event was sent successfully to the inbox API for processing
-
Error message: If there was an issue, such as an invalid JSON or a missing product token.
-
Tips
-
Always ensure your JSON body is valid before sending it.