Events - Post Event

Send a pipeline job event to be processed by the execution plan.

POST https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/events?api-version=7.1

URI Parameters

Name In Required Type Description
hubName
path True

string

The name of the server hub. Common examples: "build", "rm", "checks"

organization
path True

string

The name of the Azure DevOps organization.

planId
path True

string

uuid

The ID of the plan.

scopeIdentifier
path True

string

uuid

The project GUID to scope the request

api-version
query True

string

Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name Type Description
jobId

string

The ID of the pipeline job affected by the event.

name

string

The name of the pipeline job event.

Responses

Name Type Description
200 OK

successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Examples

Send a TaskCompletedEvent

Sample request

POST https://dev.azure.com/{organization}/{scopeIdentifier}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/events?api-version=7.1

{
  "result": "succeeded",
  "taskId": "61153303-347e-5f06-a6a1-ce2102bd68eb",
  "name": "TaskCompleted",
  "jobId": "3a7e60dc-c5b0-5009-86eb-0f217c12e2ea"
}

Sample response

Definitions

JobEvent

A pipeline job event to be processed by the execution plan.

Name Type Description
jobId

string

The ID of the pipeline job affected by the event.

name

string

The name of the pipeline job event.