External work management events
external_sub_step_started
Start an external sub step from a task.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is external_sub_step_started . |
data | object | Data of the event. |
data[task] | object | Data of the task associated with the external sub step. |
data[task][id] | string | Unique identifier of the task. |
data[task][links] | object | Links related to the task |
data[task][links][self] | string | URL to fetch the task through Optimizely Content Marketing Platform Open API. |
data[task][links][assets] | string | URL to fetch the assets associated with the task through Optimizely Content Marketing Platform Open API. |
data[step] | object | Data of the step associated with the external sub step. |
data[step][id] | string | Unique identifier of the step. |
data[step][links] | object | Links related to the step. |
data[step][links][task] | string | URL to fetch the task associated with the step through Optimizely Content Marketing Platform Open API. |
data[sub_step] | object | Data of the sub step associated with the external sub step. |
data[sub_step][id] | string | Unique identifier of the sub step. |
data[sub_step][links] | object | Links related to the sub step. |
data[sub_step][links][self] | string | URL to fetch the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][task] | string | URL to fetch the task associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][external_work] | string | URL to fetch the external work associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[external_work] | object | Data of the external work associated with the external sub step. |
data[external_work][external_system] | string | Name of the external system associated with the external work. |
data[external_work][links] | object | Links related to the external work. |
data[external_work][links][self] | string | URL to fetch the external work through Optimizely Content Marketing Platform Open API. |
data[external_work][links][task] | string | URL to fetch the task associated with the external work through Optimizely Content Marketing Platform Open API. |
data[external_work][links][sub_step] | string | URL to fetch the sub step associated with the external work through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "external_sub_step_started",
"data": {
"task": {
"id": "5f6a0312a5963d0591015e3e",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
}
},
"step": {
"id": "5f68911d83eeb10591933b49",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
}
},
"sub_step": {
"id": "5f68911d83eeb10591933b4a",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"external_work": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work"
}
},
"external_work": {
"external_system": "Trello",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"sub_step": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
}
}
}
}
external_sub_step_completed
Complete an external sub step from a task.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is external_sub_step_completed . |
data | object | Data of the event. |
data[task] | object | Data of the task associated with the external sub step. |
data[task][id] | string | Unique identifier of the task. |
data[task][links] | object | Links related to the task |
data[task][links][self] | string | URL to fetch the task through Optimizely Content Marketing Platform Open API. |
data[task][links][assets] | string | URL to fetch the assets associated with the task through Optimizely Content Marketing Platform Open API. |
data[step] | object | Data of the step associated with the external sub step. |
data[step][id] | string | Unique identifier of the step. |
data[step][links] | object | Links related to the step. |
data[step][links][task] | string | URL to fetch the task associated with the step through Optimizely Content Marketing Platform Open API. |
data[sub_step] | object | Data of the sub step associated with the external sub step. |
data[sub_step][id] | string | Unique identifier of the sub step. |
data[sub_step][links] | object | Links related to the sub step. |
data[sub_step][links][self] | string | URL to fetch the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][task] | string | URL to fetch the task associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][external_work] | string | URL to fetch the external work associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[external_work] | object | Data of the external work associated with the external sub step. |
data[external_work][external_system] | string | Name of the external system associated with the external work. |
data[external_work][links] | object | Links related to the external work. |
data[external_work][links][self] | string | URL to fetch the external work through Optimizely Content Marketing Platform Open API. |
data[external_work][links][task] | string | URL to fetch the task associated with the external work through Optimizely Content Marketing Platform Open API. |
data[external_work][links][sub_step] | string | URL to fetch the sub step associated with the external work through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "external_sub_step_completed",
"data": {
"task": {
"id": "5f6a0312a5963d0591015e3e",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
}
},
"step": {
"id": "5f68911d83eeb10591933b49",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
}
},
"sub_step": {
"id": "5f68911d83eeb10591933b4a",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"external_work": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work"
}
},
"external_work": {
"external_system": "Trello",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"sub_step": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
}
}
}
}
external_sub_step_modified
Modify the assignee or due date of an external sub step.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is external_sub_step_modfied . |
data | object | Data of the event. |
data[task] | object | Data of the task associated with the external sub step. |
data[task][id] | string | Unique identifier of the task. |
data[task][links] | object | Links related to the task |
data[task][links][self] | string | URL to fetch the task through Optimizely Content Marketing Platform Open API. |
data[task][links][assets] | string | URL to fetch the assets associated with the task through Optimizely Content Marketing Platform Open API. |
data[step] | object | Data of the step associated with the external sub step. |
data[step][id] | string | Unique identifier of the step. |
data[step][links] | object | Links related to the step. |
data[step][links][task] | string | URL to fetch the task associated with the step through Optimizely Content Marketing Platform Open API. |
data[sub_step] | object | Data of the sub step associated with the external sub step. |
data[sub_step][id] | string | Unique identifier of the sub step. |
data[sub_step][links] | object | Links related to the sub step. |
data[sub_step][links][self] | string | URL to fetch the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][task] | string | URL to fetch the task associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][external_work] | string | URL to fetch the external work associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[external_work] | object | Data of the external work associated with the external sub step. |
data[external_work][external_system] | string | Name of the external system associated with the external work. |
data[external_work][links] | object | Links related to the external work. |
data[external_work][links][self] | string | URL to fetch the external work through Optimizely Content Marketing Platform Open API. |
data[external_work][links][task] | string | URL to fetch the task associated with the external work through Optimizely Content Marketing Platform Open API. |
data[external_work][links][sub_step] | string | URL to fetch the sub step associated with the external work through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "external_sub_step_modified",
"data": {
"task": {
"id": "5f6a0312a5963d0591015e3e",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
}
},
"step": {
"id": "5f68911d83eeb10591933b49",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
}
},
"sub_step": {
"id": "5f68911d83eeb10591933b4a",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"external_work": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work"
}
},
"external_work": {
"external_system": "Jira",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"sub_step": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
}
}
}
}
external_sub_step_comment_added
Add a top-level comment to an external sub-step.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is external_sub_step_comment_added . |
data | object | Data of the event. |
data[task] | object | Data of the task associated with the external sub step. |
data[task][id] | string | Unique identifier of the task. |
data[task][links] | object | Links related to the task |
data[task][links][self] | string | URL to fetch the task through Optimizely Content Marketing Platform Open API. |
data[task][links][assets] | string | URL to fetch the assets associated with the task through Optimizely Content Marketing Platform Open API. |
data[step] | object | Data of the step associated with the external sub step. |
data[step][id] | string | Unique identifier of the step. |
data[step][links] | object | Links related to the step. |
data[step][links][task] | string | URL to fetch the task associated with the step through Optimizely Content Marketing Platform Open API. |
data[sub_step] | object | Data of the sub step associated with the external sub step. |
data[sub_step][id] | string | Unique identifier of the sub step. |
data[sub_step][links] | object | Links related to the sub step. |
data[sub_step][links][self] | string | URL to fetch the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][task] | string | URL to fetch the task associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][external_work] | string | URL to fetch the external work associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][comments] | string | URL to fetch the comments associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[comment] | object | Data of the comment. |
data[comment][id] | string | Unique identifier of the comment. |
data[comment][links] | object | Links related to the comment. |
data[comment][links][self] | string | URL to fetch the comment through Optimizely Content Marketing Platform Open API. |
data[comment][links][task] | string | URL to fetch the task associated with the comment through Optimizely Content Marketing Platform Open API. |
data[comment][links][sub_step] | string | URL to fetch the sub step associated with the comment through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "external_sub_step_comment_added",
"data": {
"task": {
"id": "5f6a0312a5963d0591015e3e",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
}
},
"step": {
"id": "5f68911d83eeb10591933b49",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
}
},
"sub_step": {
"id": "5f68911d83eeb10591933b4a",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"external_work": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
"comments": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments"
}
},
"comment": {
"id": "8f68911d83eeb10591933b4q",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments/8f68911d83eeb10591933b4q",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"sub_step": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
}
}
}
}
external_sub_step_comment_removed
Remove a top-level comment from an external sub-step.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is external_sub_step_comment_removed . |
data | object | Data of the event. |
data[task] | object | Data of the task associated with the external sub step. |
data[task][id] | string | Unique identifier of the task. |
data[task][links] | object | Links related to the task |
data[task][links][self] | string | URL to fetch the task through Optimizely Content Marketing Platform Open API. |
data[task][links][assets] | string | URL to fetch the assets associated with the task through Optimizely Content Marketing Platform Open API. |
data[step] | object | Data of the step associated with the external sub step. |
data[step][id] | string | Unique identifier of the step. |
data[step][links] | object | Links related to the step. |
data[step][links][task] | string | URL to fetch the task associated with the step through Optimizely Content Marketing Platform Open API. |
data[sub_step] | object | Data of the sub step associated with the external sub step. |
data[sub_step][id] | string | Unique identifier of the sub step. |
data[sub_step][links] | object | Links related to the sub step. |
data[sub_step][links][self] | string | URL to fetch the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][task] | string | URL to fetch the task associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][external_work] | string | URL to fetch the external work associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][comments] | string | URL to fetch the comments associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[comment] | object | Data of the comment. |
data[comment][id] | string | Unique identifier of the comment. |
data[comment][links] | object | Links related to the comment. |
data[comment][links][task] | string | URL to fetch the task associated with the comment through Optimizely Content Marketing Platform Open API. |
data[comment][links][sub_step] | string | URL to fetch the sub step associated with the comment through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "external_sub_step_comment_removed",
"data": {
"task": {
"id": "5f6a0312a5963d0591015e3e",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
}
},
"step": {
"id": "5f68911d83eeb10591933b49",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
}
},
"sub_step": {
"id": "5f68911d83eeb10591933b4a",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"external_work": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
"comments": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments"
}
},
"comment": {
"id": "8f68911d83eeb10591933b4q",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"sub_step": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
}
}
}
}
external_sub_step_comment_modified
Modify a top-level comment of an external sub-step of a task.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this event, the value is external_sub_step_comment_modified . |
data | object | Data of the event. |
data[task] | object | Data of the task associated with the external sub step. |
data[task][id] | string | Unique identifier of the task. |
data[task][links] | object | Links related to the task |
data[task][links][self] | string | URL to fetch the task through Optimizely Content Marketing Platform Open API. |
data[task][links][assets] | string | URL to fetch the assets associated with the task through Optimizely Content Marketing Platform Open API. |
data[step] | object | Data of the step associated with the external sub step. |
data[step][id] | string | Unique identifier of the step. |
data[step][links] | object | Links related to the step. |
data[step][links][task] | string | URL to fetch the task associated with the step through Optimizely Content Marketing Platform Open API. |
data[sub_step] | object | Data of the sub step associated with the external sub step. |
data[sub_step][id] | string | Unique identifier of the sub step. |
data[sub_step][links] | object | Links related to the sub step. |
data[sub_step][links][self] | string | URL to fetch the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][task] | string | URL to fetch the task associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][external_work] | string | URL to fetch the external work associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[sub_step][links][comments] | string | URL to fetch the comments associated with the sub step through Optimizely Content Marketing Platform Open API. |
data[comment] | object | Data of the comment. |
data[comment][id] | string | Unique identifier of the comment. |
data[comment][links] | object | Links related to the comment. |
data[comment][links][self] | string | URL to fetch the comment through Optimizely Content Marketing Platform Open API. |
data[comment][links][task] | string | URL to fetch the task associated with the comment through Optimizely Content Marketing Platform Open API. |
data[comment][links][sub_step] | string | URL to fetch the sub step associated with the comment through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "external_sub_step_comment_modified",
"data": {
"task": {
"id": "5f6a0312a5963d0591015e3e",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"assets": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
}
},
"step": {
"id": "5f68911d83eeb10591933b49",
"links": {
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e"
}
},
"sub_step": {
"id": "5f68911d83eeb10591933b4a",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"external_work": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
"comments": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments"
}
},
"comment": {
"id": "8f68911d83eeb10591933b4q",
"links": {
"self": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments/8f68911d83eeb10591933b4q",
"task": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e",
"sub_step": "https://api.welcomesoftware.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
}
}
}
}
Updated 10 days ago