Skip to main content

Setup an App

You should create a Sirius App if you need to receive events from Sirius.

A Sirius App represents an external system that receives events from Sirius.

Create a Sirius App​

  1. Login to Sirius, if you don't have an account, ask a Sirius owner to create one for you.

  2. Be sure your user has the "apps:full", usually the "Owner" role.

  3. Go to the admin (it could require to be connected through VPN to have admin access).

  4. Go to "Apps" section.

  5. Click on "Créer une app".

Create app

  1. Give your app a meaningful name. This name will be displayed to users.

  2. Choose a transport between Webhook and Google Cloud Pub/Sub.

If you choose Webhook

  1. Specify a URL, this URL will be used by Sirius to make POST request.

  2. Specify a secret to secure your webhooks and ensure your server is only receiving the expected Sirius requests.

If you choose GCP Pub/Sub

  1. Choose a GCP integration and a topic. Be careful, GCP service account must have rights to publish on the topic and Sirius does not create the topic automatically, you have to create it by yourself.

  2. Configure actions.

Check Sirius App connection​

  1. Update a tag, a "tag.updated" event will be sent to your application

  2. Check the recent messages received by your app, a link is accessible at the bottom of your app config page.

See recent messages

  • If a red cross is displayed, it means that Sirius has not been able to publish the message. For a Webhook it means an error status code, for Pub/Sub it means that Sirius has not been able to publish the message in the topic.

Publish failed

  • If a green check is displayed, it means that Sirius has been able to publish the message.

Publish success

  1. Check that your app receive the message correctly, it is always a good idea to log events you received from Sirius.