List Cloud App templates

Use this endpoint to get the list of Cloud App templates.

API at a glance

Description: This API lists the Cloud App templates in your Blueshift account. You can filter the list by name, Cloud App, author, archived status and tags, and you can page through the results.

Authentication & testing

Testing the API on this page

How to try it here

  • Use your User API Key as the Username (leave Password blank).
  • Select the appropriate API endpoint based on your Blueshift region.
  • API - Select Region
  • Enter the necessary parameters and click Try It to run the request.
Authentication using Base64 encoding

Note for developers

API requests require authentication using HTTP Basic Authentication with an API key. The API key serves as the username, while the password field should be left empty. The format to encode is: your_api_key: (note the trailing colon).

This string must be Base64-encoded and included in the request's Authorization header as follows:

Authorization: Basic encoded_value

You can generate the encoded value using a trusted Base64 encoder.


Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.


Things to know before you start

  • API key: Use your User API key.
  • Paging: Without page, the API returns every matching template as a plain array, most recently updated first. With page, it returns one page inside a results object.
  • Page numbers start at 0. page=0 is the first page. total_pages is the number of the last page, so it's -1 when nothing matches.
  • Custom JSON templates: A template that isn't linked to a Cloud App has app_name and app_uuid set to null.
  • Use case: Best for finding a template's uuid before you get or update it.

Request parameters

Check out the request parameters

Query parameters

ParameterTypeRequiredDescription
namestring❌ NoReturns templates whose name contains this text. Not case-sensitive.
app_uuidstring❌ NoReturns templates that use this Cloud App.
author[]array❌ NoReturns templates created by these users. Send one author[] per email address, for example author[][email protected]&author[][email protected].
archivedboolean❌ Notrue returns archived templates, false returns templates that aren't archived. Leave it out to return both.
tag_datastring❌ NoReturns templates with these tags, in the format folder_name:tag1,tag2. Separate folders with |. Within a folder, a template must have all the listed tags. Templates that match any folder are returned.
pageinteger❌ NoPage number, starting at 0. Send it to get a paged response.
per_pageinteger❌ NoNumber of templates per page when you send page. Default: 25.

Example requests & responses

List Cloud App templates

Request

curl --request GET \
     --url 'https://api.getblueshift.com/api/v1/webhook_templates.json' \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_API_KEY>'

Response

[
  {
    "name": "Order confirmation webhook v3",
    "created_at": "2026-11-19T05:53:43.000Z",
    "updated_at": "2026-11-19T05:56:47.000Z",
    "uuid": "75f48ce5-7955-48d9-a06d-88732b1b079f",
    "archived": false,
    "author": "Jane Doe",
    "resource": {
      "app_name": null,
      "app_uuid": null
    }
  },
  {
    "name": "Shipping update webhook",
    "created_at": "2026-11-17T09:54:22.000Z",
    "updated_at": "2026-11-17T09:54:22.000Z",
    "uuid": "11bda352-a3f1-45a2-81f9-11b107f343b7",
    "archived": false,
    "author": "John Smith",
    "resource": {
      "app_name": "My Cloud App",
      "app_uuid": "421ccc78-744c-4058-85e1-102a29eeb925"
    }
  }
]
List Cloud App templates one page at a time

Request

curl --request GET \
     --url 'https://api.getblueshift.com/api/v1/webhook_templates.json?page=0&per_page=2' \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_API_KEY>'

Response

{
  "total_count": 127.0,
  "total_pages": 63,
  "per_page": 2,
  "page": 0,
  "results": [
    {
      "name": "Order confirmation webhook v3",
      "created_at": "2026-11-19T05:53:43.000Z",
      "updated_at": "2026-11-19T05:56:47.000Z",
      "uuid": "75f48ce5-7955-48d9-a06d-88732b1b079f",
      "archived": false,
      "author": "Jane Doe",
      "resource": {
        "app_name": null,
        "app_uuid": null
      }
    },
    {
      "name": "Shipping update webhook",
      "created_at": "2026-11-17T09:54:22.000Z",
      "updated_at": "2026-11-17T09:54:22.000Z",
      "uuid": "11bda352-a3f1-45a2-81f9-11b107f343b7",
      "archived": false,
      "author": "John Smith",
      "resource": {
        "app_name": "My Cloud App",
        "app_uuid": "421ccc78-744c-4058-85e1-102a29eeb925"
      }
    }
  ]
}
Query Params
string

Templates whose name contains this text. Not case-sensitive.

string

Templates that use this Cloud App.

author[]
array of strings

Email address of an author. Repeat author[] for each email.

author[]
boolean

true for archived templates, false for templates that aren't archived. Leave out for both.

string

folder_name:tag1,tag2. Separate folders with |. Within a folder, a template must have all the listed tags; templates that match any folder are returned.

integer
≥ 0

Page number, starting at 0. Send it to get a paged response.

integer
Defaults to 25

Templates per page when page is sent. Default 25.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json