Delete a webhook

DELETE

/api/domains/{domain}/webhooks/{webhookGuid}

const url = 'https://smtp-app.kirim.email/api/domains/example.com/webhooks/550e8400-e29b-41d4-a716-446655440000';
const options = {method: 'DELETE'};

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

curl --request DELETE \
  --url https://smtp-app.kirim.email/api/domains/example.com/webhooks/550e8400-e29b-41d4-a716-446655440000

Remove a webhook configuration from 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

webhookGuid

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Unique identifier (GUID) of the webhook to delete

Responses

204

Webhook deleted successfully

Headers

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window

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."
}