VOOZH about

URL: https://docs.similarweb.com/api-v5/batch-api-general/webhook-endpoints/test-your-webhooks-get

⇱ Similarweb API V5 Documentation

Getting Started

Sections

Theme switcher

Test Your Webhooks (GET)

This endpoint provides you with the ability to test your webhooks against internal Similarweb services that might want to send you notifications.

📘 General Note Regarding Webhooks

When submitting a URL as a webhook we will always try to trigger it with an HTTP POST request.

Header Parameters

api-keystring Required

Your Similarweb Batch API key.

Body Parameters

webhook_urlstring Required

The URL to test. Similarweb will trigger it with an HTTP POST request.

Response

200 Webhook triggered successfully
Object

Webhook was triggered successfully.

Response Attributes

event_typestring

Identifier of the test event sent to your webhook.

payloadstring

Confirmation message delivered to your webhook URL.

400 Webhook trigger failed
Object

Errors encountered when trying to trigger your URL (e.g., timeout after 5 seconds).

Response Attributes

errorsarray

List of errors encountered while triggering the webhook URL.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?