This resource represents events. Use this resource to send events into an event source.
Sends an event into an event source. This API is rate limited. Only 100 requests per user per minute are allowed.
string
RequiredCompassEventInputDto
Requiredstring
Returned if the process of sending of an event is started.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
curl --request POST \
--url 'https://your-domain.atlassian.net/gateway/api/compass/v1/events' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"cloudId": "<string>",
"event": {
"deployment": {
"displayName": "<string>",
"updateSequenceNumber": 137,
"url": "<string>",
"description": "<string>",
"lastUpdated": "<string>",
"externalEventSourceId": "<string>",
"deploymentProperties": {
"sequenceNumber": 39,
"state": "PENDING",
"pipeline": {
"pipelineId": "<string>",
"url": "<string>",
"displayName": "<string>"
},
"environment": {
"category": "PRODUCTION",
"displayName": "<string>",
"environmentId": "<string>"
}
}
},
"build": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"buildProperties": {
"state": "IN_PROGRESS",
"pipeline": {
"pipelineId": "<string>"
},
"startedAt": "<string>"
}
},
"incident": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"incidentProperties": {
"id": "<string>",
"state": "OPEN",
"startTime": "<string>"
}
},
"flag": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"flagProperties": {
"id": "<string>"
}
},
"alert": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"alertProperties": {
"id": "<string>"
}
},
"lifecycle": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"lifecycleProperties": {
"id": "<string>",
"stage": "PRE_RELEASE"
}
},
"custom": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"customEventProperties": {
"id": "<string>",
"icon": "INFO"
}
},
"push": {
"displayName": "<string>",
"lastUpdated": "<string>",
"updateSequenceNumber": 137,
"description": "<string>",
"url": "<string>",
"externalEventSourceId": "<string>",
"pushEventProperties": {
"id": "<string>",
"branchName": "<string>"
}
},
"pullRequest": {
"lastUpdated": "<string>",
"cloudId": "<string>",
"pullRequestProperties": {
"id": "<string>",
"repoUrl": "<string>",
"pullRequestUrl": "<string>",
"status": "CREATED"
}
}
},
"componentId": "<string>"
}'Rate this page: