Webhooks
Test webhook endpoint
Changed onSends a test webhook to the specified URL and returns the result.
Use case. Verify your webhook endpoint is correctly configured before using it in production.
Payload types:
- success - simulates successful code retrieval with verification data
- failed - simulates failed code retrieval with error message
Your endpoint must return HTTP 200 to indicate successful receipt.
Testing tool. Use https://webhook.site to get a temporary URL for testing.
No persistence. Test webhooks are not stored in delivery history.
post/v1/webhooks/test
Request
- Base URLhttps://api.getmytg.com
- URLhttps://api.getmytg.com/v1/webhooks/test
- Auth
- API key in header x-api-key
- or HTTP bearer
Request body
Example request
{
"url": "https://example.com/webhooks/handler",
"type": "success"
}Response
Result of webhook test request.
Example response
{
"success": true,
"http_code": 200,
"response_time_ms": 150,
"response_body": "OK"
}Changes
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info