InboxKit
  1. Webhook
InboxKit
  • Introduction
  • Order
    • Place Order
      POST
  • Webhook
    • Status Change Webhook
      POST
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      POST
    • List assignable domains
      GET
    • Set DMARC policy
      POST
    • Remove DMARC policy
      DELETE
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
  • Mailboxes
    • List mailboxes
    • Show mailbox credentials
    • Get mailbox details
    • Buy mailboxes
    • Check mailbox status
    • Cancel mailboxes
    • Update mailbox
    • Update mailbox profile picture
    • Generate TOTP
    • Change username
    • Change password
    • Check mailbox availability
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  • Consent Request
    • Initiate Consent Request
    • Get Consent Request Status
    • List Consent Requests
  • Tags
    • Assign tags to domains or mailboxes
    • Get all tags
    • Create a new tag
    • Delete a tag
  • Prewarm
    • Search Domains
    • Search Mailboxes
    • Buy Prewarmed Mailboxes
    • Check Order Status
  1. Webhook

Status Change Webhook

POST
https://api.inboxkit.com/webhook
Maintainer:Not configured
Receives webhook notifications when domain or mailbox status changes
Your Response CodeInboxKit Action
200-299✅ Success - No retry
400-499❌ Client error - No retry
500-599🔄 Server error - Will retry (3 times)
Timeout (>10s)🔄 Will retry (3 times)

Requirements Summary#

1.
Return HTTP 200-299 for successful processing
2.
Respond within 10 seconds to avoid timeout
3.
Handle duplicates using the uid field as unique identifier
4.
Return proper status codes to control retry behavior

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Webhook processed successfully
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.inboxkit.com/webhook' \
--header 'X-InboxKit-Signature: sha256=b0344c61d8db38e0f469e85fc6e8c055e0742e8d9a9c5a9e8e4d3f7c5a8b9c0d' \
--header 'X-InboxKit-Event: domain.status_changed' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "domain.status_changed",
    "timestamp": "2024-01-10T15:30:45.123Z",
    "team_id": "team-abc123def456",
    "team_name": "Marketing Team",
    "workspace_id": "ws_456def789abc",
    "data": {
        "domain": {
            "uid": "domain-xyz789ghi012",
            "name": "yourdomain.com",
            "tld": "com",
            "status": "active",
            "previous_status": "pending",
            "dns_propagation_status": "completed",
            "nameservers": [
                "ns1.inboxkit.com",
                "ns2.inboxkit.com"
            ],
            "connection_type": "dns",
            "assigned_mailboxes": 0,
            "available_mailboxes": 50,
            "tags": [
                "production",
                "marketing"
            ],
            "renewal_date": "2025-01-10T00:00:00.000Z",
            "renewal_status": "not_due"
        },
        "change_details": {
            "reason": "DNS propagation completed successfully",
            "changed_fields": [
                "status",
                "dns_propagation_status"
            ],
            "triggered_by": "system"
        }
    }
}'
Response Response Example
200 - Success
{
    "success": true,
    "message": "Webhook processed successfully",
    "received_at": "2024-01-10T15:30:45.123Z"
}
Modified at 2025-09-11 09:35:15
Previous
Place Order
Next
Get account details
Built with