Skip to main content
POST
Send test delivery

Authorizations

X-API-Key
string
header
required

Your UGiftMe API key for authentication.

Format: Secure API key (e.g., <your-api-key>)

Required: All endpoints require this header

Example: X-API-Key: <your-api-key>

Body

application/json
webhookId
string
required

Id of a webhook subscription you own

Example:

"65d3f4a5b6c7d89012345678"

Response

Test delivery attempt result

ok
boolean
required

Whether your endpoint returned HTTP 2xx

payload
object
required
Example:
statusCode
integer

HTTP status from your endpoint, if a response was received

Example:

200

errorMessage
string

Present when ok is false