v1

latestOpenAPI 3.0.02026-07-13105112106.9 KB

Events

Creates a new event marker (e.g. deployment, incident, config change).

post/v1/accounts/{accountSid}/events

Path parameters

accountSidstring required

accountSid

Request body

typestring required

Event type (e.g. deployment, incident, config_change, scale, custom)

namestring required

Human-readable event name

descriptionstring nullable

Optional longer description

sourcestring nullable

Source of the event (e.g. github_actions, gitlab_ci, jenkins, manual)

metadataModel19 nullable

Freeform key/value metadata (e.g. commitSha, branch, imageTag)

bucketSidsstring[]

Bucket sids this event applies to. Defaults to ["*"] (all).

environmentSidsstring[]

Environment sids this event applies to. Defaults to ["*"] (all).

startedAtstring

When the event started. Defaults to now.

endedAtstring nullable

When the event ended. Null for point-in-time events.

Response

Successful

sidstring required

EventSid

accountSidstring required

Sid of the account

bucketSidsstring[] required

Bucket sids this event applies to

environmentSidsstring[] required

Environment sids this event applies to

typestring required

Event type (e.g. deployment, incident, config_change)

namestring required

Human-readable event name

descriptionstring nullable

Optional longer description

sourcestring nullable

Source of the event (e.g. github_actions, jenkins)

metadataMetadata nullable

Freeform key/value metadata

startedAtstring required

When the event started

endedAtstring nullable

When the event ended (null for point-in-time events)

createdAtstring required

When the record was created

updatedAtstring nullable

When the record was last updated