The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Events Management

Listing Events

To list the events that a user has permission to see, use the event list command.

shipa event list [--kind/-k kind name]... [--owner/-o owner] [--running/-r] [--target/-t target type] [--target-value/-v target value]

Flags:

Flag

Description

-k, --kind

(= []) Filter events by kind

-o, --owner

(= "") Filter events by owner

-r, --running

(= false) Shows only currently running events

-t, --target

(= "") Filter events by target type

-v, --target-value

(= "") Filter events by target value

Event Information

To show detailed information about a specific event, use the event info command.

shipa event info <event-id>

Cancelling Events

To cancel a running event, use the event cancel command.

shipa event cancel <event-id> <reason> [-y]

Flags:

Flag

Description

-y, --assume-yes

(= false) Don't ask for confirmation

Adding Event Blocks

To block an event, use the event block add command.

shipa event block add <reason> [-k/--kind kindName] [-o/--owner ownerName] [-t/--target targetType] [-v/--value targetValue]

Flags:

Flag

Description

-k, --kind

(= "") Event kind to be blocked

-o, --owner

(= "") Block a specific owner's events

-t, --target

(= "") Block events with a specific target type

-v, --value

(= "") Block events with a specific target value

Removing Event Blocks

To remove an event block, use the event block remove command.

shipa event block remove <ID>

Updated 3 months ago


What's Next

Sample webhooks

Event Webhook

Events Management


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.