Webhooks

info

Webhooks is still in preview, contact us if would like to try it out.

Webhooks in Enterspeed are HTTP callbacks that will send all generated views by schemas with the destinations field to a URL configured in the Webhook. This means that you can decide on the schema level which views you want to send to the webhook.

You will only have to set the destination field on the entity schema you want to send to the webhook. All schema references are automatically resolved so you don't have to set it on all referenced schemas.

Request

The request to the client-configured URL will be made with the following configuration.

Setting	Value	Description
Retry count	3	How many times the webhook will try to send the request
Timeout	10	The request timeout in seconds
HTTP method	POST	Teh requests is made as a POST
Headers	X-Api-Key X-Enterspeed-Webhook-Name X-Enterspeed-System	Two headers will be send with the request. X-Api-Key will hold a key so that the client can validate that the request is actually coming from Enterspeed X-Enterspeed-Webhook-Name will hold the name of the webhook X-Enterspeed-System will hold the version number of the webhook

Payload

The request will send the following data.

{
  "id": "gid://Environment/2052b78d-6c34-4f11-bea5-296cf2d26968/Source/053b598b-c3d1-46fb-91e3-53115169cdb2/Entity/1234/View/product", // the Enterspeed view id
  "OriginId": "1234", // the origin id of the entity
  "Type": "product", // the type of the entity
  "Action": "Deploy", // can have the value of Deploy or Remove
  "properties": { } // contains all the data for the view
}