Execute a test event

Before deploying your webhook endpoint function into a live environment, it's advisable to conduct thorough testing of your application integration. Use the following endpoint to test your webhook subscription.

EndpointPurpose
POST {URI}/webhooks/{webhookId}/tests/{testName}To test webhook subscription

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

ParameterData typeDescription
webhookIdstring(Required) The webhook identifier
testNamestring(Required) Requested test to execute. Currently, only the “ConnectivityTest” is available.

The following request shows how to test your webhook subscription sing POST {URI}/webhooks/{webhookId}/tests/{testName}:

-- 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

The following response messages are possible for this endpoint:

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found

Connectivity test

The first release of this test endpoint tests the connectivity of the subscription where {testName} is set to ConnectivityTest. This will look like 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.

EndpointPurpose
POST {URI}/webhooks/{webhookId}/tests/ConnectivityTestTo execute a connectivity test


Rewards as a Service™ and the RaaS® API are provided by Tango Card, Inc. © 2024 Tango Card, Inc.