Webhooks

Webhooks provide a mechanism for notifying client applications when certain events happen on the server. This is an efficient alternative to polling for changes. You can configure a webhook by logging into the gospace AI console and navigating to Admin > Settings > Webhooks.

Webhook security

To verify that the request comes from gospace AI, a x-gospace-signature header is added to each request. The value of this header is a HMAC SHA256 hash computed from the request body and your webhook signature key.

RESPONSE HEADERS

headers: {
  "x-gospace-signature": "11eu12e102ru102ur102ru019u2r102ur012ur09"
}

Webhook format

When an event occurs, we will make a POST request to the URL specified when you created the webhook. The request body will contain an event object which includes the topic string and data object.

REQUEST

{
  topic: <topic string>,
  data: {
    _id: <entity ID>
  }
}

Webhook events

gospace AI features an extensive events library that allows organisations to subscribe to and act on real-time events. This powerful feature enables businesses to track actions and automate responses, creating a dynamic and interactive AI environment.

Event	Description
ALLOCATION_CREATED	An allocation has been created.
ALLOCATION_UPDATED	An allocation has been updated.
ALLOCATION_DELETED	An allocation has been deleted.
INTENTION_CREATED	An intention has been created.
INTENTION_UPDATED	An intention has been updated.
INTENTION_DELETED	An intention has been deleted.