Send a test event

Delivers a signed webhook.test event like any other, without waiting for the receiver, so you can check your signature. At most five per minute.

POSThttps://api.sofia-post.com/api/v1/webhooks/{id}/test

POST/v1/webhooks/{id}/test

API key or access tokenKept in this tab only, and sent only to api.sofia-post.com.id (path)

This request acts on your real account.

curl -X POST 'https://api.sofia-post.com/api/v1/webhooks/{id}/test' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Authorizations

Authorizationstringrequired
Your personal key or OAuth access token, sent as Bearer <token>.

202application/json

The test event is accepted and delivered outside the request.

deliveryIdstringrequired
The delivery of the webhook.test, attempted outside the request

401

The token is missing, unknown, expired or revoked.

403

The token does not have the webhooks:write scope.

404

webhook_not_found: unknown, or it belongs to another application.

429

More than five test events within the minute.

4XXapplication/json

Any other error, in the error envelope.

Send a test event

curl --request POST \
  --url 'https://api.sofia-post.com/api/v1/webhooks/<id>/test' \
  --header "Authorization: Bearer $SOFIA_API_KEY"

{
  "deliveryId": "string"
}