Skip to content
Kirim.Email SMTP API

Test a webhook URL

POST
/api/domains/{domain}/webhooks/test

Send a test webhook event to the specified URL to verify it can receive webhook notifications

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string
Example
example.com

Domain name that must be owned by the authenticated user

Request Body required

Section titled “Request Body required ”

Test webhook parameters

object
url
required

URL endpoint to test

string format: uri
Example
https://example.com/webhook
event_type
required

Event type to use for the test

string
Allowed values: queued send delivered bounced failed permanent_fail opened clicked unsubscribed temporary_fail deferred
Example
delivered

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Webhook test completed successfully

object
success

Indicates the webhook test was successful

boolean
Example
true
message

Human-readable result message

string
Example
Webhook test completed successfully
data

Test result details

object
url

The tested webhook URL

string
Example
https://example.com/webhook
event_type

The event type used for testing

string
Example
delivered
response_status

HTTP status code received from webhook URL

integer
Example
200
response_time

Response time in milliseconds

integer
Example
150

401

Section titled “401 ”

Unauthorized - Invalid or missing authentication credentials

object
success
boolean
message
string
Example
Unauthorized

404

Section titled “404 ”

Not Found - Domain or webhook not found

object
success
boolean
message
string
Example
Domain not found or you do not own this domain

422

Section titled “422 ”

Validation Error - Invalid input data

object
success
boolean
message
string
Example
Validation failed.
errors

Field-specific validation errors

object

424

Section titled “424 ”

Webhook test failed - URL did not respond correctly

object
success

Indicates the webhook test failed

boolean
message

Human-readable error message

string
Example
Webhook URL did not respond correctly
data

Test result details

object
url

The tested webhook URL

string
Example
https://example.com/webhook
event_type

The event type used for testing

string
Example
delivered
response_status

HTTP status code received from webhook URL

integer
Example
404
response_time

Response time in milliseconds

integer
0

429

Section titled “429 ”

Too Many Requests - Rate limit exceeded. Retry after the specified time.

object
success
boolean
message
string
Example
Too many attempts. Please try again later.

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Maximum requests per minute

X-RateLimit-Remaining
integer

Remaining requests in current window

500

Section titled “500 ”

Server Error - Unexpected error occurred

object
success
boolean
message
string
Example
An error occurred while processing the request.