Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI ReferenceChangelogUser Guide
Dev GuideRecipesAPI ReferenceChangelog
Dev GuideAPI ReferenceChangelogUser GuideDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
Dev CommunityOptimizely AcademySubmit a ticket
Start typing to search…

External work management

external_sub_step_started

An external substep was started from a task.

Payload

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

Example

{
  "event_name": "external_sub_step_started",
  "data": {
    "task": {
      "id": "5f6a0312a5963d0591015e3e",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "assets": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
      }
    },
    "step": {
      "id": "5f68911d83eeb10591933b49",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e"
      }
    },
    "sub_step": {
      "id": "5f68911d83eeb10591933b4a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "external_work": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work"
      }
    },
    "external_work": {
      "external_system": "Trello",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "sub_step": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
      }
    }
  }
}

external_sub_step_completed

An external substep was completed from a task.

Payload

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

Example

{
  "event_name": "external_sub_step_completed",
  "data": {
    "task": {
      "id": "5f6a0312a5963d0591015e3e",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "assets": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
      }
    },
    "step": {
      "id": "5f68911d83eeb10591933b49",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e"
      }
    },
    "sub_step": {
      "id": "5f68911d83eeb10591933b4a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "external_work": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work"
      }
    },
    "external_work": {
      "external_system": "Trello",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "sub_step": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
      }
    }
  }
}

external_sub_step_modified

The assignee or due date of an external substep was modified.

Payload

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

Example

{
  "event_name": "external_sub_step_modified",
  "data": {
    "task": {
      "id": "5f6a0312a5963d0591015e3e",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "assets": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
      }
    },
    "step": {
      "id": "5f68911d83eeb10591933b49",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e"
      }
    },
    "sub_step": {
      "id": "5f68911d83eeb10591933b4a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "external_work": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work"
      }
    },
    "external_work": {
      "external_system": "Jira",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "sub_step": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
      }
    }
  }
}

external_sub_step_comment_added

A top-level comment was added to an external substep.

Payload

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

Example

{
  "event_name": "external_sub_step_comment_added",
  "data": {
    "task": {
      "id": "5f6a0312a5963d0591015e3e",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "assets": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
      }
    },
    "step": {
      "id": "5f68911d83eeb10591933b49",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e"
      }
    },
    "sub_step": {
      "id": "5f68911d83eeb10591933b4a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "external_work": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
        "comments": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments"
      }
    },
    "comment": {
      "id": "8f68911d83eeb10591933b4q",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments/8f68911d83eeb10591933b4q",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "sub_step": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
      }
    }
  }
}

external_sub_step_comment_removed

A top-level comment was removed from an external substep.

Payload

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

Example

{
  "event_name": "external_sub_step_comment_removed",
  "data": {
    "task": {
      "id": "5f6a0312a5963d0591015e3e",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "assets": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
      }
    },
    "step": {
      "id": "5f68911d83eeb10591933b49",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e"
      }
    },
    "sub_step": {
      "id": "5f68911d83eeb10591933b4a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "external_work": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
        "comments": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments"
      }
    },
    "comment": {
      "id": "8f68911d83eeb10591933b4q",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "sub_step": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
      }
    }
  }
}

external_sub_step_comment_modified

A top-level comment was modified in an external substep of a task.

Payload

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

Example

{
  "event_name": "external_sub_step_comment_modified",
  "data": {
    "task": {
      "id": "5f6a0312a5963d0591015e3e",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "assets": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/assets"
      }
    },
    "step": {
      "id": "5f68911d83eeb10591933b49",
      "links": {
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e"
      }
    },
    "sub_step": {
      "id": "5f68911d83eeb10591933b4a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "external_work": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/external-work",
        "comments": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments"
      }
    },
    "comment": {
      "id": "8f68911d83eeb10591933b4q",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a/comments/8f68911d83eeb10591933b4q",
        "task": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e",
        "sub_step": "https://api.cmp.optimizely.com/v3/tasks/5f6a0312a5963d0591015e3e/steps/5f68911d83eeb10591933b49/sub-steps/5f68911d83eeb10591933b4a"
      }
    }
  }
}