Blackbird Service API
This is the Blackbird Service API app for Blackbird. We can hear you thinking, isn’t that a bit too Blackbird-ception? On the contrary! With the Blackbird Service API app you can orchestrate workflows that involve Blackbird itself. Common use cases are Flight logging, error handling and user management.
With the Blackbird app you can connect to any Blackbird instance independent of hosted environment or organization. This means that you are not limited to your own organization.
Before setting up
Section titled “Before setting up”Before you can connect you need to make sure that:
- You have admin privileges on the Blackbird instance you want to connect to.
Obtaining an API key
Section titled “Obtaining an API key”- While logged in to your Blackbird organization, click on the user icon on the top right and select Organization management.
- Click on API Tokens in the panel on your left.
- Click Generate
- Copy the token that you just generated by clicking on the copy button under Manage.
Connecting
Section titled “Connecting”- Navigate to apps and search for Blackbird. Select the Blackbird app.
- Click Add connection
- Give your connection a name.
- Under Instance, select which instance of Blackbird you are using, for example Europe (eu-1) (https://eu-1.blackbird.io).
- Under API token, fill in the API token you have just created.
- Click Connect.
Actions
Section titled “Actions”- Get latest notifications Get the latest notifications across all Nests
- Search users Search all users
- Get user Get details of a specific user
- Search Nests Search all Nests
- Get Nest Get details of a specific Nest
- Add user to Nest Add a user to a specific Nest
- Remove user from Nest Remove a user from a specific Nest
- Search Birds Search Birds in a specific Nest
Advanced settings:
- Trigger type: Filter Birds by trigger type.
- Status: Filter Birds by status.
- Get Bird Get details of a specific Bird
- Get Bird logs Get logs for a specific Bird
- Fly Bird Start a Flight for a published manual Bird
Flights
Section titled “Flights”- Search Flights Search Flights for a specific Bird
Advanced settings:
- Minimum start date: Filter Flights that started on or after this date.
- Maximum start date: Filter Flights that started on or before this date.
- Get Flight Get details of a specific Flight
- Get Flight Logs Get logs for a specific Flight
Events
Section titled “Events”- On Bird activated On a Bird activated
Advanced settings:
- Nest ID: Limit events to a specific Nest.
- On Bird published On a Bird published
- On Bird suspended On a Bird suspended
Flights
Section titled “Flights”- On Flight started On a Flight started
Advanced settings:
- Bird IDs: Limit events to specific Birds.
- Bird status: Limit events to Birds with a specific status.
- On Flight succeeded On a Flight succeeded
- On Flight failed On a Flight failed
- On Nest created On a Nest created
- On Nest deleted On a Nest deleted
- On user added to Nest On a user added to a Nest
- On user removed from Nest On a user removed from a Nest
Notifications
Section titled “Notifications”- On Notification received On a notification received
Examples
Section titled “Examples”Error handling
Section titled “Error handling”
This incredibly simple Bird will send a notification in Slack when any Flight fails. This can be useful for alerting people about possible issues. An alternative, or suplementary action to Slack would be logging a ticket in f.e. Jira.
Feedback
Section titled “Feedback”Do you want to use this app or do you have feedback on our implementation? Reach out to us using the established channels or create an issue.