Get webhooks for a domain

GET

/api/domains/{domain}/webhooks

const url = 'https://smtp-app.kirim.email/api/domains/example.com/webhooks?type=queued';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://smtp-app.kirim.email/api/domains/example.com/webhooks?type=queued'

Retrieve a list of webhook configurations for the specified domain owned by the authenticated user

Authorizations

userAuth

Parameters

Path Parameters

domain

required

string

Example

example.com

Domain name that must be owned by the authenticated user

Query Parameters

type

string

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

Example

delivered

Filter webhooks by event type

Responses

200

Successfully retrieved webhook list for the domain

application/json

object

success

Indicates the request was successful

boolean

data

Array of webhook configurations

Array<object>

Webhook configuration for email event notifications

object

webhook_guid

Unique identifier for the webhook

string format: uuid

user_guid

GUID of the user who owns the webhook

string

user_domain_guid

GUID of the domain associated with the webhook

string

user_smtp_guid

GUID of the SMTP configuration

string

type

Event type that triggers the webhook

string

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

url

URL endpoint where webhook events will be sent

string format: uri

is_deleted

Whether the webhook has been deleted

boolean

created_at

Unix timestamp when the webhook was created

integer

modified_at

Unix timestamp when the webhook was last modified

integer

count

Number of webhooks returned

integer

Example

{
  "success": true,
  "data": [
    {
      "webhook_guid": "550e8400-e29b-41d4-a716-446655440000",
      "user_guid": "user-guid-123",
      "user_domain_guid": "domain-guid-456",
      "user_smtp_guid": "smtp-guid-789",
      "type": "queued",
      "url": "https://example.com/webhook",
      "is_deleted": false,
      "created_at": 1640995200,
      "modified_at": 1640995200
    }
  ],
  "count": 5
}

401

Unauthorized - Invalid or missing authentication credentials

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Unauthorized"
}

404

Not Found - Domain or webhook not found

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Domain not found or you do not own this domain"
}

422

Validation Error - Invalid input data

application/json

object

success

boolean

message

string

errors

Field-specific validation errors

object

Example

{
  "success": false,
  "message": "Validation failed."
}

429

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

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Too many attempts. Please try again later."
}

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

Server Error - Unexpected error occurred

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "An error occurred while processing the request."
}