Webhooks

Webhooks let you subscribe to real-time events in Cakewalk and trigger external workflows.

Setup

To register a webhook, you need to provide:

  • Target URL

  • Events to subscribe to

  • Secret for HMAC verification

Event
Description
action_task.actionable

This event is triggered when the action step of the request needs to be executed. e.g. "all the review steps are completed and the task to do the provisioning is ready to be done"

Example out put for: action_task.actionable

{
  "eventType" : "action_task.actionable",
  "data" : {
    "taskId" : "7ac60a4b-4b4d-4fc1-988c-f95254591f06",
    "assignedTo" : [ ],
    "requestMetadata" : {
      "reviewedBy" : [ {
        "id" : "c1b264ce-29bf-47f3-973a-e0f0187e430f",
        "email" : "[email protected]",
        "fullName" : "superadmin"
      } ],
      "requestType" : "GrantAccessRequest",
      "requestedBy" : {
        "id" : "c1b264ce-29bf-47f3-973a-e0f0187e430f",
        "email" : "[email protected]",
        "fullName" : "superadmin"
      },
      "targetWorkApp" : {
        "id" : "b95160f2-1eec-4cf0-8f49-bb4f29936f5d",
        "name" : "Google Workspace"
      },
      "permissionLevel" : null,
      "targetUser" : {
        "id" : "1934ea57-962f-41de-bf2c-ba2c288e7f68",
        "email" : "[email protected]",
        "fullName" : "admin"
      }
    }
  }
}

Last updated

Was this helpful?