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.
PEOPLE_CREATED	A person has been created.
PEOPLE_UPDATED	A person has been update.
PEOPLE_DELETED	A person has been deleted.
PEOPLE_SETTINGS_CREATED	People settings have been created.
PEOPLE_SETTINGS_UPDATED	People settings have been created.
TEAM_CREATED	A team has been created.
TEAM_UPDATED	A team has been updated.
TEAM_DELETED	A team has been deleted.
TEAM_SETTINGS_CREATED	Team settings have been created.
TEAM_SETTINGS_UPDATED	Team settings have been updated.
TEAM_MEMBER_ADDED	A team member has been added.
TEAM_MEMBER_REMOVED	A team member has been removed.
LOCATION_CREATED	A location has been created.
LOCATION_UPDATED	A location has been updated.
LOCATION_DELETED	A location has been deleted.
LAYER_CREATED	A layer has been created.
LAYER_UPDATED	A layer has been updated.
LAYER_DELETED	A layer has been deleted.
ZONE_CREATED	A zone has been created.
ZONE_UPDATED	A zone has been updated.
ZONE_DELETED	A zone has been deleted.
ROOM_CREATED	A room has been created.
ROOM_UPDATED	A room has been updated.
ROOM_DELETED	A room has been deleted.
SPACE_CREATED	A space has been created.
SPACE_UPDATED	A space has been updated.
SPACE_DELETED	A space has been deleted.
CLUSTER_CREATED	A space cluster has been created.
CLUSTER_UPDATED	A space cluster has been updated.
CLUSTER_DELETED	A space cluster has been deleted.
CIRCULATION_ROUTE_CREATED	A circulation path has been created.
CIRCULATION_ROUTE_UPDATED	A circulation path has been updated.
CIRCULATION_ROUTE_DELETED	A circulation path has been deleted.