HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

External Work Management events

external_sub_step_started

When an external sub step is started from a task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is external_sub_step_started.
dataobjectData of the event.
data[task]objectData of the task associated with the external sub step.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets associated with the task through Welcome Open API.
data[step]objectData of the step associated with the external sub step.
data[step][id]stringUnique identifier of the step.
data[step][links]objectLinks related to the step.
data[step][links][task]stringURL to fetch the task associated with the step through Welcome Open API.
data[sub_step]objectData of the sub step associated with the external sub step.
data[sub_step][id]stringUnique identifier of the sub step.
data[sub_step][links]objectLinks related to the sub step.
data[sub_step][links][self]stringURL to fetch the sub step through Welcome Open API.
data[sub_step][links][task]stringURL to fetch the task associated with the sub step through Welcome Open API.
data[sub_step][links][external_work]stringURL to fetch the external work associated with the sub step through Welcome Open API.
data[external_work]objectData of the external work associated with the external sub step.
data[external_work][external_system]stringName of the external system associated with the external work.
data[external_work][links]objectLinks related to the external work.
data[external_work][links][self]stringURL to fetch the external work through Welcome Open API.
data[external_work][links][task]stringURL to fetch the task associated with the external work through Welcome Open API.
data[external_work][links][sub_step]stringURL to fetch the sub step associated with the external work through Welcome 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

When an external sub step is completed from a task.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is external_sub_step_completed.
dataobjectData of the event.
data[task]objectData of the task associated with the external sub step.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets associated with the task through Welcome Open API.
data[step]objectData of the step associated with the external sub step.
data[step][id]stringUnique identifier of the step.
data[step][links]objectLinks related to the step.
data[step][links][task]stringURL to fetch the task associated with the step through Welcome Open API.
data[sub_step]objectData of the sub step associated with the external sub step.
data[sub_step][id]stringUnique identifier of the sub step.
data[sub_step][links]objectLinks related to the sub step.
data[sub_step][links][self]stringURL to fetch the sub step through Welcome Open API.
data[sub_step][links][task]stringURL to fetch the task associated with the sub step through Welcome Open API.
data[sub_step][links][external_work]stringURL to fetch the external work associated with the sub step through Welcome Open API.
data[external_work]objectData of the external work associated with the external sub step.
data[external_work][external_system]stringName of the external system associated with the external work.
data[external_work][links]objectLinks related to the external work.
data[external_work][links][self]stringURL to fetch the external work through Welcome Open API.
data[external_work][links][task]stringURL to fetch the task associated with the external work through Welcome Open API.
data[external_work][links][sub_step]stringURL to fetch the sub step associated with the external work through Welcome 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

When the assignee or due date of an external sub step is modified.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is external_sub_step_modfied.
dataobjectData of the event.
data[task]objectData of the task associated with the external sub step.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets associated with the task through Welcome Open API.
data[step]objectData of the step associated with the external sub step.
data[step][id]stringUnique identifier of the step.
data[step][links]objectLinks related to the step.
data[step][links][task]stringURL to fetch the task associated with the step through Welcome Open API.
data[sub_step]objectData of the sub step associated with the external sub step.
data[sub_step][id]stringUnique identifier of the sub step.
data[sub_step][links]objectLinks related to the sub step.
data[sub_step][links][self]stringURL to fetch the sub step through Welcome Open API.
data[sub_step][links][task]stringURL to fetch the task associated with the sub step through Welcome Open API.
data[sub_step][links][external_work]stringURL to fetch the external work associated with the sub step through Welcome Open API.
data[external_work]objectData of the external work associated with the external sub step.
data[external_work][external_system]stringName of the external system associated with the external work.
data[external_work][links]objectLinks related to the external work.
data[external_work][links][self]stringURL to fetch the external work through Welcome Open API.
data[external_work][links][task]stringURL to fetch the task associated with the external work through Welcome Open API.
data[external_work][links][sub_step]stringURL to fetch the sub step associated with the external work through Welcome 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

When a top level comment is added to an external sub step.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is external_sub_step_comment_added.
dataobjectData of the event.
data[task]objectData of the task associated with the external sub step.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets associated with the task through Welcome Open API.
data[step]objectData of the step associated with the external sub step.
data[step][id]stringUnique identifier of the step.
data[step][links]objectLinks related to the step.
data[step][links][task]stringURL to fetch the task associated with the step through Welcome Open API.
data[sub_step]objectData of the sub step associated with the external sub step.
data[sub_step][id]stringUnique identifier of the sub step.
data[sub_step][links]objectLinks related to the sub step.
data[sub_step][links][self]stringURL to fetch the sub step through Welcome Open API.
data[sub_step][links][task]stringURL to fetch the task associated with the sub step through Welcome Open API.
data[sub_step][links][external_work]stringURL to fetch the external work associated with the sub step through Welcome Open API.
data[sub_step][links][comments]stringURL to fetch the comments associated with the sub step through Welcome Open API.
data[comment]objectData of the comment.
data[comment][id]stringUnique identifier of the comment.
data[comment][links]objectLinks related to the comment.
data[comment][links][self]stringURL to fetch the comment through Welcome Open API.
data[comment][links][task]stringURL to fetch the task associated with the comment through Welcome Open API.
data[comment][links][sub_step]stringURL to fetch the sub step associated with the comment through Welcome 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

When a top level comment is removed from an external sub step.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is external_sub_step_comment_removed.
dataobjectData of the event.
data[task]objectData of the task associated with the external sub step.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets associated with the task through Welcome Open API.
data[step]objectData of the step associated with the external sub step.
data[step][id]stringUnique identifier of the step.
data[step][links]objectLinks related to the step.
data[step][links][task]stringURL to fetch the task associated with the step through Welcome Open API.
data[sub_step]objectData of the sub step associated with the external sub step.
data[sub_step][id]stringUnique identifier of the sub step.
data[sub_step][links]objectLinks related to the sub step.
data[sub_step][links][self]stringURL to fetch the sub step through Welcome Open API.
data[sub_step][links][task]stringURL to fetch the task associated with the sub step through Welcome Open API.
data[sub_step][links][external_work]stringURL to fetch the external work associated with the sub step through Welcome Open API.
data[sub_step][links][comments]stringURL to fetch the comments associated with the sub step through Welcome Open API.
data[comment]objectData of the comment.
data[comment][id]stringUnique identifier of the comment.
data[comment][links]objectLinks related to the comment.
data[comment][links][task]stringURL to fetch the task associated with the comment through Welcome Open API.
data[comment][links][sub_step]stringURL to fetch the sub step associated with the comment through Welcome 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

When a top level comment of an external sub step of a task is modified.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is external_sub_step_comment_modified.
dataobjectData of the event.
data[task]objectData of the task associated with the external sub step.
data[task][id]stringUnique identifier of the task.
data[task][links]objectLinks related to the task
data[task][links][self]stringURL to fetch the task through Welcome Open API.
data[task][links][assets]stringURL to fetch the assets associated with the task through Welcome Open API.
data[step]objectData of the step associated with the external sub step.
data[step][id]stringUnique identifier of the step.
data[step][links]objectLinks related to the step.
data[step][links][task]stringURL to fetch the task associated with the step through Welcome Open API.
data[sub_step]objectData of the sub step associated with the external sub step.
data[sub_step][id]stringUnique identifier of the sub step.
data[sub_step][links]objectLinks related to the sub step.
data[sub_step][links][self]stringURL to fetch the sub step through Welcome Open API.
data[sub_step][links][task]stringURL to fetch the task associated with the sub step through Welcome Open API.
data[sub_step][links][external_work]stringURL to fetch the external work associated with the sub step through Welcome Open API.
data[sub_step][links][comments]stringURL to fetch the comments associated with the sub step through Welcome Open API.
data[comment]objectData of the comment.
data[comment][id]stringUnique identifier of the comment.
data[comment][links]objectLinks related to the comment.
data[comment][links][self]stringURL to fetch the comment through Welcome Open API.
data[comment][links][task]stringURL to fetch the task associated with the comment through Welcome Open API.
data[comment][links][sub_step]stringURL to fetch the sub step associated with the comment through Welcome 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"
            }
        }
    }
}

Did this page help you?