Get a Cloud App template

Use this endpoint to get a JSON representation of a Cloud App template along with a list of campaigns using the template.

API at a glance

Description: This API gets one Cloud App template from your Blueshift account, with its request settings, tags, external fetches, transaction mixins and the campaigns that use it.

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.
  • Template UUID: Get it from List Cloud App templates.
  • Auth token: auth_token is never returned. If the template has one, the response shows ***.
  • Campaigns: Only this API returns the campaigns list. Create and update responses don't include it.

Request parameters

Check out the request parameters

Path parameters

ParameterTypeRequiredDescription
template_uuidstring✅ YesThe UUID of the Cloud App template.

Example requests & responses

Get a Cloud App template

Request

curl --request GET \
     --url 'https://api.getblueshift.com/api/v1/webhook_templates/75f48ce5-7955-48d9-a06d-88732b1b079f.json' \
     --header 'accept: application/json' \
     --header 'authorization: Basic <YOUR_API_KEY>'

Response

{
  "name": "Order confirmation webhook v2",
  "created_at": "2026-11-19T05:53:43.000Z",
  "updated_at": "2026-11-19T05:53:52.000Z",
  "uuid": "75f48ce5-7955-48d9-a06d-88732b1b079f",
  "skip_user_on_external_fetch_error": null,
  "archived": false,
  "author": "Jane Doe",
  "template_properties": [
    {
      "name": "products",
      "context": {
        "product_count": 20
      },
      "settings": {
        "product_count": 20
      },
      "skip_user_on_blank_products": true,
      "skip_user_on_blank_event_products": true,
      "skip_on_all_blank_recommendation_blocks": false,
      "account_algorithm_uuid": null
    }
  ],
  "tag_data": "",
  "campaigns": [],
  "external_fetches": [],
  "transaction_mixins": [],
  "resource": {
    "auth_header": "Authorization",
    "http_method": "POST",
    "external_webhook_url": "https://example.com/orders",
    "content": "{ \"email\": \"{{user.email}}\", \"src\": \"api\" }",
    "dedupe_field": null,
    "context": null,
    "is_url_encoded_form": false,
    "headers": {
      "X-Source": "blueshift"
    },
    "content_metadata": null,
    "use_json_editor": false,
    "auth_token": "***",
    "app_uuid": null,
    "account_app_profile_uuid": null,
    "app_name": null
  }
}
Template not found

Response (404)

{
  "message": "Not Found"
}
Path Params
string
required

Specify the UUID of the Cloud App template. You can copy the UUID from the URL of the template on the Blueshift app. For example, if you open a template in the Blueshift app, its URL looks like https://app.getblueshift.com/dashboard#/app/webhook_template/studio/<template_uuid>/edit/info.

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