Metrics
Events

Rate this page:

Events

This resource represents events. Use this resource to send events into an event source.

Send event

POST /gateway/api/compass/v1/events

Sends an event into an event source.

OAuth scopes required
NONE

Request

Body parameters
cloudId Required

string

The cloud ID of the site to create the event for.

event Required

CompassEventInputDto

The type of event. One and only one of the fields in this input type must be provided.

Example

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
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": {
      "updateSequenceNumber": 57,
      "displayName": "<string>",
      "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": 57,
      "description": "<string>",
      "url": "<string>",
      "externalEventSourceId": "<string>",
      "buildProperties": {
        "state": "IN_PROGRESS",
        "pipeline": {
          "pipelineId": "<string>"
        },
        "startedAt": "<string>"
      }
    },
    "incident": {
      "displayName": "<string>",
      "lastUpdated": "<string>",
      "updateSequenceNumber": 57,
      "description": "<string>",
      "url": "<string>",
      "externalEventSourceId": "<string>",
      "incidentProperties": {
        "id": "<string>",
        "state": "OPEN"
      }
    },
    "flag": {
      "displayName": "<string>",
      "lastUpdated": "<string>",
      "updateSequenceNumber": 57,
      "description": "<string>",
      "url": "<string>",
      "externalEventSourceId": "<string>",
      "flagProperties": {
        "id": "<string>"
      }
    },
    "alert": {
      "displayName": "<string>",
      "lastUpdated": "<string>",
      "updateSequenceNumber": 57,
      "description": "<string>",
      "url": "<string>",
      "externalEventSourceId": "<string>",
      "alertProperties": {
        "id": "<string>"
      }
    },
    "lifecycle": {
      "displayName": "<string>",
      "lastUpdated": "<string>",
      "updateSequenceNumber": 57,
      "description": "<string>",
      "url": "<string>",
      "externalEventSourceId": "<string>",
      "lifecycleProperties": {
        "id": "<string>",
        "stage": "PRE_RELEASE"
      }
    },
    "custom": {
      "displayName": "<string>",
      "lastUpdated": "<string>",
      "updateSequenceNumber": 57,
      "description": "<string>",
      "url": "<string>",
      "externalEventSourceId": "<string>",
      "customEventProperties": {
        "id": "<string>",
        "icon": "INFO"
      }
    }
  }
}'

Responses

Returned if the process of sending of an event is started.

A schema has not been defined for this response code.

Rate this page: