Klaviyo Lists

Reads Klaviyo lists, for example to find a list’s ID by its name before creating a campaign for it.

Configuration

- klaviyo_lists:
    name: find_list
    operation: list
    credentials_path: /etc/klaviyo/credentials.json
    filter: "equals(name,'Newsletter')"

Fields

FieldTypeDefaultDescription
namestringrequiredTask name.
operationstringrequiredget or list.
credentials_pathstringrequiredPath to the credentials file.
base_urlstringKlaviyo’sKlaviyo API address, for example a proxy.
list_idstringList ID for get.
filterstringKlaviyo filter for list, e.g. equals(name,'Newsletter'). Without it, list returns every list.
depends_onlistUpstream task names.
retryobjectRetry configuration.

Output

The Klaviyo response as JSON. list emits one event per page, with the lists in data; a name that matches no list gives one event with an empty data.