Signicat Events Management (v1)

The Events Management API enables you to process events generated by Signicat services.

By creating a Subscription, you can have events pushed to your service whenever something interesting happens in a Signicat service. See each service's documentation for detailed information on which events are interesting to you and how to use them.

This API is part of our management APIs, which allow you to programmatically manage configurations that are typically handled in the Signicat Dashboard.

This REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

The Events Management service is the entry point into processing events generated by our services. By creating a Subscription you can have events pushed to your service whenever something interesting happens in a Signicat service. See each service's documentation for detailed information on which events are interesting to you and how to use them.

The following table provides an overview of all events accessible through the events service.

Metadata endpoints provide information that are useful to services and user interfaces integrating with the Event Management Service.

Subscriptions are used to listen to events generated by Signicat services. Different types of subscriptions are available, allowing your application to listen to events in the way best suited for you.

Azure Service Bus

By creating a subscription of type AzureServiceBus we can push events directly to your Azure Service Bus queue.

Configuration: Locate your Service Bus in the Azure Portal. On the tab named "Shared Access Policies", add a policy named "Signicat" which has the Send claim and no other claims. Use the connection string from this shared access policy when creating your subscription.

Google Pub/Sub

By creating a subscription of type GooglePubSub we can push events directly to your Google Pub Sub topic.

Configuration: Locate Service accounts in Google Cloud console under IAM and admin. Create a new service account or use existing. Click manage keys under actions and add a key using type json. Copy the contents of the file into the credential parameter when creating your subscription.

Webhooks

By creating a subscription of type Webhook we can push events directly to your application using HTTP requests.