Domains

The following webhooks are triggered by domain records.

domain.created

This event is triggered when a new domain was created in your partner account.

Payload

{
  "event": "domain.created",
  "params": {
    "domain_id": "string",
    "domain": "string",
    "action": "string",
    "source": "string",
    "status": "string",
    "country": "string",
    "state": "string",   // optional
    "city": "string", // optional
    "address": "string", // optional
    "postal_code": "string", //optional
    "vat_number": "string", // optional
    "product_id": number,
    "price_list_id": number,
    "has_docs": boolean,
    "has_dsar": boolean,
    "has_scripts": boolean,
    "has_accessibility": boolean,
    "display_dpo": boolean,
    "display_company": boolean,    
    "send_intro": boolean,
    "company_name": "string",
    "company_trade_name": "string", // optional
    "account_email": "string",
    "account_first_name": "string", // optional
    "account_last_name": "string", // optional
    "subscription_id": "string",
    "merchant_id": "string"  // optional
  },
  "entity": {
    "kind": "domain",
    "data": {
      "id": "string",
      "hostname": "string",
      "status": "string",
      "has_scripts": boolean,
      "has_dsar": boolean,
      "has_docs": boolean,
      "has_accessibility": boolean,
      "display_dpo": boolean,
      "display_company": boolean,
      "instance_property_id": "string",
      "instance_company_id": "string",
      "instance": {
        "id": number,
        "name": "string",
        "hostname": "string",
        "region": "string"
      },
      "created_at": "string",
      "updated_at": "string"     
    }
  }
}

domain.deactivated

This event is triggered when a domain was deactivated.

Payload

{
  "event": "domain.deactivated",
  "params": {
    "domain": "string",
    "domain_id": "string"
  },
  "entity": {
    "kind": "domain",
    "data": {
      "id": "string",
      "hostname": "string",
      "status": "string",
      "has_scripts": boolean,
      "has_dsara": boolean,
      "has_docs": boolean,
      "has_accessibility": boolean,
      "display_dpo": boolean,
      "display_company": boolean,
      "instance_property_id": "string",
      "instance_company_id": "string",
      "instance": {
        "id": number,
        "name": "string",
        "hostname": "string",
        "region": "string"
      },
      "created_at": "string",
      "updated_at": "string"     
    }
  }
}

domain.deleted

This event is triggered when a domain was permanently deleted from our systems.

Payload

{
  "event": "domain.deleted",
  "params": {
    "id": "string",
    "domain": "string",
    "property_id": "string",
    "company_id": "string",
    "subscriptions": ["string"]
  }
}