Skip to main content

Trigger

  • Updated

Objective

You can set the triggers and sync URL at Trigger menu.

  1. Location
  2. Steps

Details 

1) Location

Group Console ▶ Developer page ▶ Trigger ▶Choose a company to set trigger


2) Steps

[Set sync]

1. Enter the URL and click 'Update' button.
2. Go to style page. You can see the sync button activated.
3. Click sync button to open new tab with the URL you entered above. The new tab's URL contains Style ID, style version, external style ID as query string.

[Set Render trigger]

1. Click 'ADD TRIGGER' under Render section.
2. Choose workflow status that fires the trigger.
renderSett.png
3. Go to Workroom or Style page and change Workflow of style.
4. Render is then requested.
    To see in on the page, you need to refresh.
   *Render will be requested with the uploaded file's render properties set in CLO S/W.

renderTrigger.gif

 

[Set Webhook]

1. Click 'Add trigger' under webhook section.
2. Choose the trigger use case at which you want to fire the trigger.  
    CLO-SET currently offers webhooks for 5 different use cases. 
         - Workflow: You can set a webhook to be fired at a specific Content Workflow.
         - Invite / Share: You can set a webhook to be fired when a user has been invited/shared to a Space/Content.
         - Content Upload: You can set a webhook to be fired when a Content is uploaded.
         - Version Upload: You can set a webhook to be fired when a Version is uploaded.
         - Colorway Status: You can set a webhook to be fired at a specific Colorway Status. 
3. Enter the URL that webhook will be requested.
4. Enter the Name and Value if you want to check whether the request is valid. It will be added in HTTP header with webhook request.

Webhook request body sample for Workflow

{
  "UpdateTime": "2025-03-21T06:25:09.759785Z",
  "UpdateUser": "hello@clo-set.com",
  "Topic": {
     "TopicType": "Style",
     "TopicId": "4ea0710a0e5f4e099d92f7a284d167f9",   
  },
  "TriggerType": "Workflow",
  "TriggerDetail": null,  
  "TriggerOption": {
    "WorkflowSeq": 1679,
    "TriggerStatus": "Changed"
  }
}

Webhook body schema

{ 
  "UpdateTime": {
    "$id": "#/properties/UpdateTime",
    "type": "string",
    "format": "date-time",
    "description": "The update time that trigger fired."
},
  "UpdateUser": {
    "$id": "#/properties/UpdateUser",
    "type": "string",
    "description": "Email address of user"
},
  "Topic": {
    "$id": "#/properties/Topic",
    "type": "object",
    "description": "The updated space/style information",
    "required": [
    "TopicId",
    "Version",
    "TopicType"
],
  "properties": {
     "TopicId": {
       "$id": "#/properties/Topic/properties/TopicId",
       "type": "string",
       "description": "The id of updated style or space"
    },
    "Version": {
      "$id": "#/properties/Topic/properties/Version",
      "type": "integer",
      "description": "Version of style. Will be '0' if topic type is not style.",
      "default": 0
    },
    "TopicType": {
      "$id": "#/properties/Topic/properties/TopicType",
      "type": "integer",
      "enum": [0, 1],
      "description": "Enum for what the topic type is. 0 is none, 1 is style.",
      "default": "None"
    }
  }
},
  "TriggerType": {
    "$id": "#/properties/TriggerType",
    "type": "integer",
    "enum": [0, 1],
    "description": "The trigger type that webhook triggered. 0 is none, 1 is workflow",
    "default": 0
  },
  "TriggerOption": {
    "$id": "#/properties/TriggerOption",
    "type": "object",
    "description": "The object information for trigger",
    "required": ["WorkflowSeq", "TriggerStatus"],
    "properties": {
        "WorkflowSeq": {
          "$id": "#/properties/TriggerOption/properties/WorkflowSeq",
          "type": "integer",
          "description": "Workflow seq that tiggered."
         },
        "TriggerStatus": {
            "$id": "#/properties/TriggerOption/properties/TriggerStatus",
            "type": "integer",
            "enum": [0, 1],
            "description": "The changed trigger status for triggered object. 0 is none, 1 is changed",
            "default": 0
         }
      }
   }
}

Related articles