Event Service

The event service provides an audit trail for all the major events happening in the EscapeKit platform. Services such as the Inventory and State service use the Event service as a sink for their events.

Endpoints

Events
Inventory Events
State Events
Subscriptions

Events

GET

/api/v1/events/query/

Get all events that the user can see based on its group permissions.

Description:

Get all events that the user can see based on its group permissions. Administrators are able to see all the events. Events can be filtered by setting the optional query parameters.

Authentication:

This is a public endpoint

Parameters:

?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.
?inventory_project=	string	Filter the events by Inventory project.
?inventory_application=	string	Filter the events by Inventory application. Only used if inventory_project is set.
?inventory_version=	string	Filter the events by release version. Only used if inventory_project and inventory_application are set.
?state_project=	string	Filter the events by State project. Only used if inventory_project is not set.
?state_environment=	string	Filter the events by State environment. Only used if state_project is set and inventory_project is not set.
?state_deployment=	string	Filter the events by State deployment. Only used if state_project and state_environment are set and inventory_project is not set.

Responses:

Status	Response Type	Description
200	Events	A page of Events

POST

/internal/create-event

Add an event.

Authentication:

This is a public endpoint

Responses:

Status	Response Type	Description
200		Empty response.

Inventory Events

GET

/api/v1/events/query/inventory/

Get all Inventory events that the user can see based on its group permissions.

Description:

Get all Inventory events that the user can see based on its group permissions. Administrators are able to see all the Inventory events.

Authentication:

This is a public endpoint

Parameters:

?page_size=		integer	Limits the number of events being returned.
?page_from=		string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

GET

/api/v1/events/query/inventory/{project}/

Get all Inventory project events (if user is in permitted groups).

Description:

Get all Inventory project events (if user is in permitted groups). Administrators are able to see all the Inventory project events.

Authentication:

This is a public endpoint

Parameters:

/{project}/	string	The Inventory project.
?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

GET

/api/v1/events/query/inventory/{project}/{application}/

Get all events for an Inventory application (if user is in permitted groups).

Description:

Get all events for an Inventory application (if user is in permitted groups). Administrators are able to see all the Inventory project application events.

Authentication:

This is a public endpoint

Parameters:

/{project}/	string	The Inventory project.
/{application}/	string	The Inventory project application.
?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

GET

/api/v1/events/query/inventory/{project}/{application}/{version}/

Get all events for a specific Inventory release (if user is in permitted groups).

Description:

Get all events for a specific Inventory release (if user is in permitted groups). Administrators are able to see all the release events.

Authentication:

This is a public endpoint

Parameters:

/{project}/	string	The Inventory project.
/{application}/	string	The Inventory project application.
/{version}/	string	The release version.
?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

State Events

GET

/api/v1/events/query/project/

Get all State events that the user can see based on its group permissions.

Description:

Get all State events that the user can see based on its group permissions. Administrators are able to see all the state events.

Authentication:

This is a public endpoint

Parameters:

?page_size=		integer	Limits the number of events being returned.
?page_from=		string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

GET

/api/v1/events/query/project/{project}/

Get all State project events (if user is in permitted groups).

Description:

Get all State project events (if user is in permitted groups). Administrators are able to see all the state project events.

Authentication:

This is a public endpoint

Parameters:

/{project}/	string	The state project.
?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

GET

/api/v1/events/query/project/{project}/{environment}/

Get all events for a specific State project environment (if user is in permitted groups).

Description:

Get all events for a specific State project environment (if user is in permitted groups). Administrators are able to see all the environment's events.

Authentication:

This is a public endpoint

Parameters:

/{project}/	string	The state project.
/{environment}/	string	The state project environment.
?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

GET

/api/v1/events/query/project/{project}/{environment}/deployment

Get all events for a specific deployment (if user is in permitted groups).

Description:

Get all events for a specific deployment (if user is in permitted groups). Administrators are able to see all the deployment's events.

Authentication:

This is a public endpoint

Parameters:

/{project}/	string	The state project.
/{environment}/	string	The state project environment.
?deployment=	string	The name of the deployment.
?page_size=	integer	Limits the number of events being returned.
?page_from=	string	The ID to start paging from. Every event will have an ID < page_from.

Responses:

Status	Response Type	Description
200	Events	A page of Events

Subscriptions

GET

/api/v1/events/subscriptions/project/{project}/

Authentication:

Unknown ACL: CanManageSubscriptionsACL()

Responses:

Status	Response Type	Description
200	Subscriptions	All project subscriptions

PUT

/api/v1/events/subscriptions/project/{project}/

Authentication:

Unknown ACL: CanManageSubscriptionsACL()

Responses:

Status	Response Type	Description
200	Subscriptions	Empty is good

Event

Description:

Describes an event having taken place in the EscapeKit platform.

Type:

object

Example:

{
    "allowed_groups": [
        "my-group", 
        "your-group"
    ], 
    "id": "123", 
    "inventory_project": "test", 
    "timestamp": 12343434343434, 
    "type": "CREATE_INVENTORY_PROJECT", 
    "username": "user"
}

Field	Type	Description	Example
allowed_roles	[ string ]	The roles that are allowed to see this event.
data	object	Additional data.
id	string	The event identifier.
inventory_application	string	The inventory application (if any) this event pertains to.
inventory_namespace	string	The inventory namespace (if any) this event pertains to.
inventory_version	string	The inventory version (if any) this event pertains to.
state_deployment	string	The state deployment (if any) this event pertains to.
state_environment	string	The state environment (if any) this event pertains to.
state_project	string	The state project (if any) this event pertains to.
timestamp	string	The event's timestamp. Unix time in nanoseconds.
type	enum	The event type.	"CREATE_INVENTORY_PROJECT" "NEW_INVENTORY_APPLICATION" "UPLOAD_INVENTORY_APPLICATION" "UPDATE_INVENTORY_PROJECT_USER_ACL" "DELETE_INVENTORY_PROJECT_USER_ACL" "UPDATE_INVENTORY_PROJECT_USER_ACL" "DELETE_INVENTORY_PROJECT_TEAM_ACL" "CREATE_STATE_PROJECT" "CREATE_STATE_ENVIRONMENT" "CREATE_STATE_DEPLOYMENT" "UPDATE_STATE_DEPLOYMENT" "REDEPLOY_STATE_DEPLOYMENT" "RERUN_SMOKE_TESTS" "DESTROY_REQUESTED" "ADD_BUILD" "TRIGGER_BUILD_WEBHOOK" "BUILD_FINISHED_EVENT" "UPDATE_STATE_PROJECT_USER_ACL" "DELETE_STATE_PROJECT_USER_ACL" "UPDATE_STATE_PROJECT_TEAM_ACL" "DELETE_STATE_PROJECT_TEAM_ACL" "USER_SIGNUP" "USER_CONFIRMED" "TEAM_CREATED" "TEAM_DELETED" "TEAM_MEMBER_UPDATED" "TEAM_MEMBER_DELETED" "TEAM_SERVICE_ACCOUNT_CREATED"
username	string	The username (if any) of the user that triggered this event.

Events

Description:

Events keyed by id.

Type:

[Event]

Example:

[
    {
        "id": "123", 
        "inventory_project": "test", 
        "timestamp": 12343434343434, 
        "type": "CREATE_INVENTORY_PROJECT", 
        "username": "user"
    }, 
    {
        "allowed_groups": [
            "my-group", 
            "your-group"
        ], 
        "id": "124", 
        "state_project": "state-test", 
        "timestamp": 12343434343435, 
        "type": "CREATE_STATE_PROJECT", 
        "username": "user"
    }
]

Subscription

Description:

Describes a subscription that the event-service will send events to

Type:

object

Field	Type	Description	Example
id	[ string ]	The groups that are allowed to see this event.
slack_icon	string	The icon to use if type is SLACK
slack_username	string	The username to use if type is SLACK
type	enum	The subscription type.	"webhook" "slack"
url	string	URL used to send events to

Subscriptions

Description:

Events keyed by id.

Type:

[Subscription]

Escape

EscapeKit

Escape

EscapeKit

API Documentation

Event Service

Endpoints

Events

Inventory Events

State Events

Subscriptions

Schemas

Event

Events

Subscription

Subscriptions