action braze_canvas_details { label: "Canvas Details" description: "This endpoint allows you to export metadata about a Canvas, such as its name, when it was created, its current status, and more.\n\n### Components Used\n- [Canvas Identifier](https://www.braze.com/docs/api/identifier_types/)\n\n## Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"created_at\": (string) date created as ISO 8601 date,\n \"updated_at\": (string) date updated as ISO 8601 date,\n \"name\": (string) Canvas name,\n \"description\": (string) Canvas description,\n \"archived\": (boolean) whether this Canvas is archived,\n \"draft\": (boolean) whether this Canvas is a draft,\n \"schedule_type\": (string) type of scheduling action,\n \"first_entry\": (string) date of first entry as ISO 8601 date,\n \"last_entry\": (string) date of last entry as ISO 8601 date,\n \"channels\": (array of strings) step channels used with Canvas,\n \"variants\": [\n {\n \"name\": (string) name of variant,\n \"id\": (string) API identifier of the variant,\n \"first_step_ids\": (array of strings) API identifiers for first steps in variant,\n \"first_step_id\": (string) API identifier of first step in variant (deprecated in November 2017, only included if the variant has only one first step)\n },\n ... (more variations)\n ],\n \"tags\": (array of strings) tag names associated with the Canvas,\n \"steps\": [\n {\n \"name\": (string) name of step,\n \"id\": (string) API identifier of the step,\n \"next_step_ids\": (array of strings) API identifiers of steps following step,\n \"channels\": (array of strings) channels used in step,\n \"messages\": {\n \"message_variation_id\": (string) { // <=This is the actual id\n \"channel\": (string) channel type of the message (eg., \"email\"),\n ... channel-specific fields for this message, see Campaign Details Endpoint API Response for example message responses ...\n }\n }\n },\n ... (more steps)\n ],\n \"message\": (required, string) the status of the export, returns 'success' when completed without errors\n}\n```" provider: braze method: GET path: "/canvas/details" encoding: json input: { type: "object" properties: { canvas_id: { type: "string" } } additionalProperties: false } output: { type: "object" additionalProperties: true } }