Create external feed | Brevo API Documentation

Creates a new external feed for dynamic content in email campaigns. **Use this to:** - Set up external data sources for dynamic content - Configure authentication for protected feeds - Enable real-time content updates in campaigns - Establish connections to product catalogs, blogs, or APIs **Key information returned:** - Created feed UUID for reference in campaigns - Success confirmation **Important considerations:** - Feed URL must be accessible from Brevo infrastructure - Authentication credentials are securely encrypted - Test feed accessibility before campaign use - Consider feed response time for campaign performance - Monitor feed reliability and uptime - Use caching for frequently accessed feeds - Maximum 5 retry attempts allowed for failed requests - Custom headers support for API integration requirements

Creates a new external feed for dynamic content in email campaigns.

Use this to:

Set up external data sources for dynamic content
Configure authentication for protected feeds
Enable real-time content updates in campaigns
Establish connections to product catalogs, blogs, or APIs

Key information returned:

Created feed UUID for reference in campaigns
Success confirmation

Important considerations:

Feed URL must be accessible from Brevo infrastructure
Authentication credentials are securely encrypted
Test feed accessibility before campaign use
Consider feed response time for campaign performance
Monitor feed reliability and uptime
Use caching for frequently accessed feeds
Maximum 5 retry attempts allowed for failed requests
Custom headers support for API integration requirements

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

External feed configuration

namestringRequired

Name of the feed

urlstringRequiredformat: "url"

URL of the external data source

authTypeenumOptionalDefaults to noAuth

Authentication type for accessing the feed

Allowed values:

usernamestringOptional

Username for basic authentication (required if authType is ‘basic’)

passwordstringOptional

Password for basic authentication (required if authType is ‘basic’)

tokenstringOptional

Token for token-based authentication (required if authType is ‘token’)

maxRetriesintegerOptional1-5Defaults to 5

Maximum number of retry attempts for failed requests

cachebooleanOptionalDefaults to true

Whether to cache the feed response

headerslist of objectsOptional

Custom HTTP headers for the feed request

Response

External feed created successfully

idstringformat: "uuidv4"

UUID of the created feed

Errors

400

Bad Request Error

Creates a new external feed for dynamic content in email campaigns.

Use this to:

Set up external data sources for dynamic content
Configure authentication for protected feeds
Enable real-time content updates in campaigns
Establish connections to product catalogs, blogs, or APIs

Key information returned:

Created feed UUID for reference in campaigns
Success confirmation

Important considerations:

Feed URL must be accessible from Brevo infrastructure
Authentication credentials are securely encrypted
Test feed accessibility before campaign use
Consider feed response time for campaign performance
Monitor feed reliability and uptime
Use caching for frequently accessed feeds
Maximum 5 retry attempts allowed for failed requests
Custom headers support for API integration requirements

The API key should be passed in the request headers as api-key for authentication.

External feed configuration

URL of the external data source

Authentication type for accessing the feed

Username for basic authentication (required if authType is ‘basic’)

Password for basic authentication (required if authType is ‘basic’)

Token for token-based authentication (required if authType is ‘token’)

Maximum number of retry attempts for failed requests

Whether to cache the feed response

Custom HTTP headers for the feed request

External feed created successfully

UUID of the created feed

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.externalFeeds.createExternalFeed({
8	name: "Public API Feed",
9	url: "https://jsonplaceholder.typicode.com/posts",
10	authType: "noAuth",
11	maxRetries: 3,
12	cache: true,
13	});
14	}
15	main();

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.externalFeeds.createExternalFeed({
8	name: "Public API Feed",
9	url: "https://jsonplaceholder.typicode.com/posts",
10	authType: "noAuth",
11	maxRetries: 3,
12	cache: true,
13	});
14	}
15	main();