v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB

Organization Domain Created

Triggered when a domain is added to an organization (organization domain or allowed email domain). The data payload may include txt_record_secret for DNS verification — treat that value as sensitive and do not log it.

postWebhookorganization.domain_created

Payload

spec_versionstring required

The webhook specification version

idstring required

Unique identifier for the webhook event (must be prefixed with "evt_")

type'organization.domain_created' required

The event type

occurred_atstring date-time required

When the event occurred (ISO 8601 format)

environment_idstring required

The environment ID where the event occurred

organization_idstring

The organization ID

object'Organization' required

The type of object that triggered the webhook

display_namestring

Human-readable display name for the event

Example payload

{
  "spec_version": "1",
  "id": "evt_4567890123",
  "type": "organization.domain_created",
  "occurred_at": "2024-01-15T11:00:00.123456789Z",
  "environment_id": "env_1234567890",
  "organization_id": "org_1234567890",
  "object": "Organization",
  "data": {
    "id": "dom_1234567890",
    "domain": "acmecorp.com",
    "domain_type": "ORGANIZATION_DOMAIN",
    "organization_id": "org_1234567890",
    "environment_id": "env_1234567890",
    "txt_record_key": "scalekit-domain-verification",
    "txt_record_secret": "<redacted>",
    "verification_status": "PENDING",
    "verification_method": "DNS",
    "updated_at": "2024-01-15T11:00:00.123456789Z"
  },
  "display_name": "Organization Domain Created"
}

Response

Webhook received successfully