Properties

The following webhooks are triggered by instance-level property records.

property.updated

This event is triggered when the instance-level property information has changed.

Payload

{
  "event": "property.updated",
  "params": {
    "property_id": "string",
     // additional changed properties
  },
  "entity": {
    "kind": "property",
    "data": {
      "id": "string",
      "name": "string",
      "description": "string",
      "status": "string",
      "widget_font": "string",
      "widget_position": "string",
      "border_radius": "string",
      "primary_color": "string",
      "text_color": "string",
      "has_scripts": boolean,
      "has_dsar": boolean,
      "has_docs": boolean,
      "has_accessibility": boolean,
      "has_accessibility_icon": boolean,
      "display_dpo": boolean,
      "display_company": boolean,
      "has_welcome_message": boolean,
      "has_continuous_scanning": boolean,
      "company_id": "string",
      "activated_at": "string",
      "created_at": "string"
    }
  }
}

property.activated

This event is triggered when the Clym script was first loaded to the property and the property was activated.

Payload

{
  "event": "property.activated",
  "params": {
    "property_id": "string",
    "domain_name": "string"
  },
  "entity": {
    "kind": "property",
    "data": {
      "id": "string",
      "name": "string",
      "description": "string",
      "status": "string",
      "widget_font": "string",
      "widget_position": "string",
      "border_radius": "string",
      "primary_color": "string",
      "text_color": "string",
      "has_scripts": boolean,
      "has_dsar": boolean,
      "has_docs": boolean,
      "has_accessibility": boolean,
      "has_accessibility_icon": boolean,
      "display_dpo": boolean,
      "display_company": boolean,
      "has_welcome_message": boolean,
      "has_continuous_scanning": boolean,
      "company_id": "string",
      "activated_at": "string",
      "created_at": "string"
    }
  }
}

property.activation.reminder.day2

This event is triggered when an instance property will receive an activation reminder that their website is not active since 2 days ago.

Payload

{
  "event": "property.activation.reminder.day2",
  "params": {
    "property_id": "string",
    "email": "string",
    "first_name": "string", // optional
    "website_url": "string",
    "domain_name": "string",
    "widget_embed_code": "string",
    "approval_url": "string"
  }
}

property.activation.reminder.day7

This event is triggered when an instance property will receive an activation reminder that their website is not active since 7 days ago.

Payload

{
  "event": "property.activation.reminder.day7",
  "params": {
    "property_id": "string",
    "email": "string",
    "first_name": "string", // optional
    "website_url": "string",
    "domain_name": "string",
    "widget_embed_code": "string",
    "approval_url": "string"
  }
}

property.activation.reminder.day14

This event is triggered when an instance property will receive an activation reminder that their website is not active since 14 days ago.

Payload

{
  "event": "property.activation.reminder.day14",
  "params": {
    "property_id": "string",
    "email": "string",
    "first_name": "string", // optional
    "website_url": "string",
    "domain_name": "string",
    "widget_embed_code": "string",
    "approval_url": "string"
  }
}

property.activation.reminder.day30

This event is triggered when an instance property will receive an activation reminder that their website is not active since 30 days ago.

Payload

{
  "event": "property.activation.reminder.day30",
  "params": {
    "property_id": "string",
    "email": "string",
    "first_name": "string", // optional
    "website_url": "string",
    "domain_name": "string",
    "widget_embed_code": "string",
    "approval_url": "string"
  }
}