Execute a specific test event

Use single event testing during development or debugging of specific event handlers. This endpoint is used to trigger a single test event for a webhook subscription. It's especially useful when you want to verify how your system handles a specific event type. Replace {webhookId} with the unique identifier of the webhook and {testName} with the name of the test you want to run:

Endpoint	Purpose
`POST {URI}/webhooks/{webhookId}/tests/{testName}`	To test webhook subscription

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 test how their system handles a RewardStatus event without triggering other types.

Parameters

The following parameters are available for POST {URI}/webhooks/{webhookId}/tests/{testName}:

Path parameter	Data type	Requirement	Description
webhookId	string	required	The unique identifier of the webhook you want to test.
testName	string	required	Shows the test event type to execute. `ConnectivityTest` is always available, while other test events can only be used in the Tango Sandbox environment. Only events under the webhookId can be tested. The enum values are: ConnectivityTest, ItemAvailability, RewardStatus, Transaction, LowBalance, AccountStatus, CredentialStatus, LineItemDeliveryStatus, AsyncOrderStatus.

The following example shows how to structure your request to test your webhook subscription:

-- Request
curl --request POST \
     --url https://integration-api.tangocard.com/raas/v2/webhooks/{webhookId}/tests/{testName} \
     --header 'accept: application/json' \
     --header 'authorization: Basic or OAuth...'

-- Response
200 OK

Connectivity test

This test is to test the connectivity of the subscription where {testName} isConnectivityTest such as in POST {URI}/webhooks/{webhookId}/tests/ConnectivityTest. This test initiates an event type of ConnectivityTest, using the standard envelope, with no meta payload. Such testing is a crucial step to guarantee the reliability and effectiveness of your webhook integration before it goes live.

Endpoint	Purpose
`POST {URI}/webhooks/{webhookId}/tests/ConnectivityTest`	To execute a connectivity 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.