Skip to content

Subjects

A subject is the item a workflow runs against. The type is ticket, pull_request, or documentation.

Every subject has:

  • id — the identifier used to dispatch provider actions. It is composite when the provider’s native id is not unique on its own.
  • key — a short reference. For a Jira issue this is the issue key. For a pull request it is a form like #123.
  • subjectType, title, url
  • source — the provider instance id that produced the subject
  • createdAt, updatedAt

Tickets also have description, status, and assignee.

Pull requests also have description, repoIdentifier, sourceBranch, targetBranch, and author. repoIdentifier is the remote as the provider returned it (for example GitHub owner/repo).

A documentation subject is page metadata. The page body is not part of that record. A workflow loads it with a get_content provider action.

raw is a provider-specific payload. It is not part of the validated subject fields.