Send a test webhook delivery
Queues a signed webhook.test event through the normal delivery and retry lifecycle.
POST
Queues a signed webhook.test event through the normal delivery and retry lifecycle.
apiKeyheader
x-api-key<token>id*stringMatch
^wep_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
data?|nullSuccess
application/json- response
accepted*trueValue in
trueeventId*WebhookEventIdMatch
^whevt_[0-9a-hjkmnp-tv-z]{16,24}$deliveryId*WebhookDeliveryIdMatch
^whdel_[0-9a-hjkmnp-tv-z]{16,24}$import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.webhooks.test({ "id": "example"});Example Response
{ "accepted": true, "eventId": "string", "deliveryId": "string"}Related documentation
Retry a webhook delivery
Performs one immediate manual redelivery attempt and returns that attempt's identity and outcome without changing the automatic retry lifecycle.
Update a webhook
Updates a webhook's name, URL, subscribed events, channels, custom headers, mailbox scope, or status and returns the updated endpoint.