Create an external fetch template

post

https://api.getblueshift.com/api/v1/external_fetches.json

Use this endpoint to create an external fetch template.

Body Params

Specify the details of the external fetch template.

alias_name

string

required

Specify the name of the external fetch template. The alias_name can contain lowercase alphanumeric characters and underscores only.

author

string

Specify the email address of the author of the template.

http_method

string

enum

required

HTTP method to fetch the data. Set GET or POST as the method.

Allowed:

auth_header

string

Along with the auth_token, specifies the details for secure URLs.

auth_token

string

Along with the auth_header, specifies the details for secure URLs.

url

string

required

The external URL. The external fetch URL may include dynamic liquid variables such as user id, email address, product ids, and more.

body

string

Specify the JSON payload if the http_method is POST.

test_context

string

Specify the test context for the template.

Responses

200

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request - The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.

401Unauthorized - API authentication failed due to an invalid or missing API key.

403Forbidden - The API key does not have sufficient permissions to perform this action.

404Not Found - The requested resource was not found.

422Unprocessable Entity - The request was well-formed but contains semantic errors.

429Too Many Requests - The request limit has been exceeded. Reduce request frequency.

500Internal Server Error - An unexpected server error occurred. Contact support if the issue persists.

502Bad Gateway - The server received an invalid response. Retry the request.

503Service Unavailable - The service is temporarily unavailable. Try again later.

504Gateway Timeout - The server took too long to respond. Retry the request with exponential backoff.