Action: API Request

Canva Operation

The API Request action in Canva allows you to send or receive data from external apps or services to automate or enhance your designs.

Example User Story

I want to automatically generate personalized certificates for event attendees, so I use the API Request action in Canva to pull attendee names from our database and create custom designs for each one.

Fields

Field Name	Field Type	Required
endpoint	String	Yes
method	String	Yes
headers	Map	No
queryParams	Map	No
body	String	No

Related Connections

Canva

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "api-request",
  "state": "inDev",
  "meta": {
    "short": "API Request",
    "description": "Send an API request to Canva's API."
  },
  "input": [
    {
      "name": "endpoint",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The Canva API endpoint to call."
      }
    },
    {
      "name": "method",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The HTTP method to use (GET, POST, PUT, PATCH, DELETE)."
      }
    },
    {
      "name": "headers",
      "type": "Map",
      "required": false,
      "meta": {
        "description": "Additional headers to include in the request."
      }
    },
    {
      "name": "queryParams",
      "type": "Map",
      "required": false,
      "meta": {
        "description": "Query parameters to include in the request."
      }
    },
    {
      "name": "body",
      "type": "String",
      "required": false,
      "meta": {
        "description": "The request body."
      }
    }
  ],
  "output": [
    {
      "name": "response",
      "type": "String",
      "selector": ["body"],
      "meta": {
        "description": "The response body from the API request."
      }
    },
    {
      "name": "statusCode",
      "type": "Integer",
      "selector": ["statusCode"],
      "meta": {
        "description": "The HTTP status code of the response."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "{{method}}",
        "path": "{{endpoint}}",
        "headers": "{{headers}}",
        "queryParams": "{{queryParams}}",
        "bodyTemplate": {
          "value": "{{body}}"
        }
      }
    }
  ]
}