Work request

15 min

work_request_added

Experimental A work request was added.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is work_request_added.
data	object	Data of the event.
data[work_request]	object	Data of the work request associated with the event.
data[work_request][id]	string	Unique identifier of the work request.
data[work_request][template]	object	Data of the template used for the work request.
data[work_request][template][id]	string	Unique identifier of the template.
data[work_request][template][links]	object	Links related to the template.
data[work_request][template][links][self]	string	URL to fetch the details of the template through the CMP Open API.
data[work_request][links]	object	Links related to the work request.
data[work_request][links][self]	string	URL to fetch the details of the work request through the CMP Open API.
data[work_request][links][comments]	string	URL to fetch comments of the work request through the CMP Open API.
data[work_request][links][campaigns]	string	URL to create campaigns from the work request through the CMP Open API.
data[work_request][links][attachments]	string	URL to add attachments to the work request through the CMP Open API.
data[work_request][links][creative_assets]	string	URL to add creative assets to the work request through the CMP Open API.

Example

{
  "event_name": "work_request_added",
  "data": {
    "work_request": {
      "id": "6f910551b00a722e0418830cee6612",
      "template": {
        "id": "83c8922aaebf4dc79eaf1da0c7dfd3f8",
        "links": {
          "self": "https://api.cmp.optimizely.com/v3/templates/83c8922aaebf4dc79eaf1da0c7dfd3f8"
        }
      },
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612",
        "comments": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/comments",
        "campaigns": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/campaigns",
        "attachments": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/attachments",
        "creative_assets": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/creative-assets"
      }
    }
  }
}

work_request_modified

Experimental A work request's status, assignees, or any form field was modified.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is work_request_modified.
data	object	Data of the event.
data[work_request]	object	Data of the work request associated with the event.
data[work_request][id]	string	Unique identifier of the work request.
data[work_request][modified_fields]	string	List of work request fields that were modified.
data[work_request][identifiers_of_modified_form_fields]	string	List of identifiers of the modified form fields of the work request.
data[work_request][links]	object	Links related to the work request.
data[work_request][links][self]	string	URL to fetch the details of the work request through the CMP Open API.
data[work_request][links][comments]	string	URL to fetch comments of the work request through the CMP Open API.
data[work_request][links][campaigns]	string	URL to create campaigns from the work request through the CMP Open API.
data[work_request][links][attachments]	string	URL to add attachments to the work request through the CMP Open API.
data[work_request][links][creative_assets]	string	URL to add creative assets to the work request through the CMP Open API.

Example

{
  "event_name": "work_request_modified",
  "data": {
    "work_request": {
      "id": "6f910551b00a722e0418830cee6612",
      "modified_fields": ["status", "assignees", "form_fields"],
      "identifiers_of_modified_form_fields": [
        "title",
        "attachment",
        "creative_assets",
        "due_date",
        "brief",
        "73e05aa2b54nda3c320242ac1d5291"
      ],
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612",
        "comments": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/comments",
        "campaigns": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/campaigns",
        "attachments": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/attachments",
        "creative_assets": "https://api.cmp.optimizely.com/v3/work-requests/6f910551b00a722e0418830cee6612/creative-assets"
      }
    }
  }
}

work_request_removed

Experimental A work request was deleted.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is work_request_removed.
data	object	Data of the event.
data[work_request]	object	Data of the work request associated with the event.
data[work_request][id]	string	Unique identifier of the work request.

Example

{
  "event_name": "work_request_removed",
  "data": {
    "work_request": {
      "id": "6f910551b00a722e0418830cee6612"
    }
  }
}

work_request_comment_added

Experimental A comment was posted in a work request.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is work_request_comment_added.
data	object	Data of the event.
data[comment_for]	object	Data of the work request related to this event.
data[comment_for][id]	string	Unique identifier of the work request.
data[comment_for][links]	object	Links related to the work request.
data[comment_for][links][self]	string	URL to fetch the details of the work request through the CMP Open API.
data[comment]	object	Data of the comment related to this event.
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 details of the comment through the CMP Open API.

Example

{
  "event_name": "work_request_comment_added",
  "data": {
    "comment_for": {
      "id": "21485ffd04804114bf9c2d01070f206a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/21485ffd04804114bf9c2d01070f206a"
      }
    },
    "comment": {
      "id": "5c01e84b23de4a4583870962bfa9e7f4",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/21485ffd04804114bf9c2d01070f206a/comments/5c01e84b23de4a4583870962bfa9e7f4"
      }
    }
  }
}

work_request_comment_modified

Experimental A work request's comment was modified.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is work_request_comment_modified.
data	object	Data of the event.
data[comment_for]	object	Data of the work request related to this event.
data[comment_for][id]	string	Unique identifier of the work request.
data[comment_for][links]	object	Links related to the work request.
data[comment_for][links][self]	string	URL to fetch the details of the work request through the CMP Open API.
data[comment]	object	Data of the comment related to this event.
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 details of the comment through the CMP Open API.

Example

{
  "event_name": "work_request_comment_modified",
  "data": {
    "comment_for": {
      "id": "21485ffd04804114bf9c2d01070f206a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/21485ffd04804114bf9c2d01070f206a"
      }
    },
    "comment": {
      "id": "5c01e84b23de4a4583870962bfa9e7f4",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/21485ffd04804114bf9c2d01070f206a/comments/5c01e84b23de4a4583870962bfa9e7f4"
      }
    }
  }
}

work_request_comment_removed

Experimental A comment was removed from a work request.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is work_request_comment_removed.
data	object	Data of the event.
data[comment_for]	object	Data of the work request related to this event.
data[comment_for][id]	string	Unique identifier of the work request.
data[comment_for][links]	object	Links related to the work request.
data[comment_for][links][self]	string	URL to fetch the details of the work request through the CMP Open API.
data[comment]	object	Data of the comment related to this event.
data[comment][id]	string	Unique identifier of the comment.

Example

{
  "event_name": "work_request_comment_removed",
  "data": {
    "comment_for": {
      "id": "21485ffd04804114bf9c2d01070f206a",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/work-requests/21485ffd04804114bf9c2d01070f206a"
      }
    },
    "comment": {
      "id": "5c01e84b23de4a4583870962bfa9e7f4"
    }
  }
}