Skip to main content

A Braze provider for Apache Airflow.

Project description

Airflow      Braze

airflow-provider-braze

An Apache Airflow provider for Braze REST API.

PyPI Python License Tests

---

Installation

pip install airflow-provider-braze

Requires Apache Airflow >= 2.9.0.

Connection Setup

In the Airflow UI, create a connection with:

Field Value
Connection Type Braze
Host Your Braze REST endpoint (e.g. https://rest.iad-03.braze.com)
Password Your Braze REST API key

Usage

from braze_provider.operators.braze_cdi import BrazeRunCDIJobOperator

sync_braze = BrazeRunCDIJobOperator(
    task_id="sync_braze_cdi",
    integration_id="your-integration-id",
    braze_conn_id="braze_default",
    poll_interval=30,
    timeout=3600,
    wait_for_completion=True,
)

Parameters

Parameter Default Description
integration_id Braze CDI integration ID (templatable)
braze_conn_id braze_default Airflow connection ID
poll_interval 30 Seconds between status checks
timeout 3600 Max seconds to wait
wait_for_completion True Set False to trigger and move on

The operator returns the full job result dict via XCom, including rows_synced and rows_failed_with_errors.

Contributing

Currently this provider only supports Cloud Data Ingestion (CDI). The BrazeHook wraps the Braze REST API and can be extended to support additional endpoints. Contributions are welcome — feel free to open a PR!

License

Apache 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airflow_provider_braze-1.0.4.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airflow_provider_braze-1.0.4-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file airflow_provider_braze-1.0.4.tar.gz.

File metadata

  • Download URL: airflow_provider_braze-1.0.4.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for airflow_provider_braze-1.0.4.tar.gz
Algorithm Hash digest
SHA256 8c5b800832db85ace0f49b56d66ce3fcfd99547ddd624feadb0af32f2f4ba12e
MD5 c7a798ed3fe6a28e87b9687d533a3b44
BLAKE2b-256 b9bd3882964b0fca8f84878f767f851b159511151e94e8543d4ff2022e939f5c

See more details on using hashes here.

File details

Details for the file airflow_provider_braze-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for airflow_provider_braze-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c4c085638e43a38db84d03bed00d8a653a0418426525743df17eba66eda41a00
MD5 41716e1dfc25170c379099ec0e435463
BLAKE2b-256 082cbdeeb48218000309f7f2c1fec6b27bcde4bca59737a5397303ba47efc10e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page