Transcend can send a webhook notification whenever the consent manager is deployed..

POST

to the webhook URL you specify in your integration settings

Request Body

application/json

versionstringmin length:1(required)
The version of the airgap.js script.
bundleTypestringmin length:1(required)enum:"PRODUCTION" | "TEST"
Whether the test or production bundle was deployed.
extrasobject(required)

Request Body Examples

Deployment made by a user to production bundle:

{
  "version": "1.1.0",
  "bundleType": "PRODUCTION",
  "extras": {
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "uri": "e-shop-it",
      "name": "eShopIt"
    },
    "airgapBundle": {
      "id": "25c5ca2b-abf9-4b67-befa-2c8c16b4e838",
      "name": "acme-org"
    },
    "user": {
      "id": "391b8ecb-9bff-4630-b93c-06021d8921f3",
      "name": "Jane Doe",
      "email": "janedoe@acme.com"
    }
  }
}

Deployment made by an API key to test bundle:

{
  "version": "1.1.0",
  "bundleType": "TEST",
  "extras": {
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "uri": "e-shop-it",
      "name": "eShopIt"
    },
    "airgapBundle": {
      "id": "25c5ca2b-abf9-4b67-befa-2c8c16b4e838",
      "name": "acme-org"
    },
    "apiKey": {
      "id": "522d4c85-7b66-461b-afb4-b80bfcc18730",
      "title": "QA API key"
    }
  }
}

Response

200 (OK)

The webhook was received successfully. Currently retry functionality is not built in for other statuses