Skip to main content

Get a notification workflow

POST 

/api/v1/notifications/manage/get-workflow

Returns the full workflow definition and metadata for the supplied workflow ID. A trigger identifier alone does not select the workflow.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Welcome a new user with an in-app message

Request​

Responses​

Workflow returned

Read an existing workflow using its saved workflow identifier.​

Section ID: DOC-CP-notifications-api-getWorkflow#example-notifications-getWorkflow-request

Request example

{
"workflowId": "welcome-notification"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-getWorkflow#example-notifications-getWorkflow-response

Response example

{
"workflow": {
"example": "value"
}
}

Document ID: DOC-CP-notifications-api-getWorkflow. Section identities and revisions.

SectionStable reference
Get a notification workflowDOC-CP-notifications-api-getWorkflow#overview
RequestDOC-CP-notifications-api-getWorkflow#request
ResponsesDOC-CP-notifications-api-getWorkflow#responses