Execute all test events under the webhook ID
Before deploying your webhook endpoint function into a live environment, we recommend you to conduct thorough testing of your application integration. Tango provides this powerful endpoint to help developers validate webhook integrations. Use this endpoint to trigger all test events that the webhook is subscribed to. This is ideal for full integration testing or validating multiple event handlers at once.
Endpoint | Purpose |
---|---|
POST {URI}/webhooks/{webhookId}/tests | To test all webhook subscriptions |
Best practice:
- Use all event testing during initial setup, QA, or regression testing to ensure full coverage.
- Use single event testing during development or debugging of specific event handlers.
Use case
Acme Health is using Tango's reward platform to deliver incentives such as gift cards and wellness rewards to users. They want to ensure their system correctly receives and processes their webhook events. Tango allows Acme Health to stimulate all of their subscribed events in their sandbox environment:
rewardStatus
: Confirming reward delivery status.itemAvailability
: Checking if a reward item is in stock.credentialStatus
: Verifying credential delivery.asyncOrderStatus
: Monitoring asynchronous order processing.lowBalance
: Alerting when account funds are low.
For a company such as Acme that relies on automated reward delivery, robust webhook testing ensures:
- Reliable integration with Tango's platform.
- Accurate tracking of reward fulfillment.
- Smooth user experience without manual intervention.
Parameters
The following parameter is available for POST {URI}/webhooks/{webhookId}/tests
:
Path parameter | Data type | Requirement | Description |
---|---|---|---|
webhookId | string | required | The unique identifier of the webhook you want to test. |
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
Response code | Meaning |
---|---|
200 | The request was successful. |
400 | The server could not understand the request due to invalid syntax. |
401 | Authentication is required and has either not been provided or failed. |
404 | The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server. |
Updated about 11 hours ago