External feeds management

This document provides a descriptive view on the public API reference for the External feed endpoints.

1. Fetch all external feeds

To call this API, you need to request the endpoint https://api.brevo.com/v3/feeds with the GET method. This endpoint performs the function of retrieving all of your created external feeds. You can use the cURL request below:

1
curl --request GET \
2
     --url 'https://api.brevo.com/v3/feeds?search=search&startDate=2022-09-04&endDate=2022-10-01&sort=desc&authType=basic&limit=50&offset=0' \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

The attributes used in the cURL request are defined below in a table.

Response

A sample JSON response for the request would be:

1
{
2
  "count": 3,
3
  "feeds": [
4
    {
5
      "id": "d955aaa4-f4d6-4557-aa14-24286542ed8d",
6
      "name": "api feed token",
7
      "url": "https://abc.com/",
8
      "authType": "token",
9
      "token": "jfhdkjdfhjkfdhjkdfhjkdfhkj",
10
      "headers": [
11
        {
12
          "name": "key",
13
          "value": "val"
14
        }
15
      ],
16
      "maxRetries": 4,
17
      "cache": true,
18
      "createdAt": "2022-10-06T05:03:47.053000000Z",
19
      "modifiedAt": "2022-10-06T05:03:47.053000000Z"
20
    },
21
    {
22
      "id": "311a71ac-bebc-42cf-963d-d8666dfe53e9",
23
      "name": "api feed basic",
24
      "url": "https://abc.com/",
25
      "authType": "basic",
26
      "username": "user",
27
      "password": "pass",
28
      "headers": null,
29
      "maxRetries": 2,
30
      "cache": false,
31
      "createdAt": "2022-10-06T04:48:19.767000000Z",
32
      "modifiedAt": "2022-10-06T04:48:19.767000000Z"
33
    }
34
  ]
35
}

Some response codes are defined in the table below:

2. Create an external feed

To create an external feed, you need to call the endpoint https://api.brevo.com/v3/feeds with the POST method. You can use the cURL request below to send a request to the API.

1
curl --request POST \
2
     --url https://api.brevo.com/v3/feeds \
3
     --header 'accept: application/json' \
4
     --header 'api-key: ' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "authType": "basic",
9
  "headers": [
10
    {
11
      "name": "userId",
12
      "value": "user12345"
13
    }
14
  ],
15
  "maxRetries": 5,
16
  "cache": false,
17
  "name": "New feed",
18
  "url": "http://requestb.in/173lyyx1",
19
  "username": "user",
20
  "password": "password",
21
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
22
}
23
'

The values and attributes to create a feed are mentioned below in a table:

As headers is an array of objects, it has two more attributes name and value:

Response

When the request is run, the API will send you an id in the response which will be the unique id of the feed. A sample is given below:

1
{
2
  "id": "23befbae-1505-47a8-bd27-e30ef739f32c"
3
}

The response codes are defined below:

3. Get an external feed by UUID

To send a request, you need to call the endpoint https://api.brevo.com/v3/feeds/{uuid} with the GET method. You can use the cURL request below:

1
curl --request GET \
2
     --url https://api.brevo.com/v3/feeds/38f351fb-6e77-4b38-979a-a2465260449e \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

There is only one attribute which is uuid which is a universal identifier for the external feed. It is defined in the table below:

Response

1
{
2
  "id": "d955aaa4-f4d6-4557-aa14-24286542ed8d",
3
  "name": "api feed token",
4
  "url": "https://abc.com/",
5
  "authType": "token",
6
  "token": "jfhdkjdfhjkfdhjkdfhjkdfhkj",
7
  "headers": [
8
    {
9
      "name": "key",
10
      "value": "val"
11
    }
12
  ],
13
  "maxRetries": 4,
14
  "cache": true,
15
  "createdAt": "2022-10-06T05:03:47.053000000Z",
16
  "modifiedAt": "2022-10-06T05:03:47.053000000Z"
17
}

4. Update an external feed

You can use this endpoint https://api.brevo.com/v3/feeds/{uuid} by calling the PUT method to update an external feed. You can use the cURL request below to send the request:

1
curl --request PUT \
2
     --url https://api.brevo.com/v3/feeds/38f351fb-6e77-4b38-979a-a2465260449e \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "headers": [
8
    {
9
      "name": "userId",
10
      "value": "user12345"
11
    }
12
  ],
13
  "maxRetries": 5,
14
  "cache": false,
15
  "name": "New feed",
16
  "url": "http://requestb.in/173lyyx1",
17
  "authType": "token",
18
  "username": "user",
19
  "password": "password",
20
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
21
}
22
'

There are two types of parameters to update a field path params and body params which are mentioned below:

Path params

Body params

As headers is an array of objects, it contains two objects which are:

Response

A sample response would show no message but with a 204 response code which shows that the external feed has been updated. Below some of the response codes and their descriptions are mentioned:

5. Delete an external feed

To delete a feed, you can call the endpoint https://api.brevo.com/v3/feeds/{uuid} with the DELETE method. For the deletion, you can make use of the cURL request below.

1
curl --request DELETE \
2
     --url https://api.brevo.com/v3/feeds/38f351fb-6e77-4b38-979a-a2465260449e \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

Only uuid is used as an attribute and it is defined below.

Response

A sample JSON response would show nothing with the response code 200 which shows that the feed has been deleted.

Response codes for this endpoint are mentioned in the table.