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.

Development

pyenv virtualenv 3.11 braze-provider
pyenv activate braze-provider
pip install -e .
pip install pytest
pytest tests/ -v

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.3.tar.gz (12.4 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.3-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airflow_provider_braze-1.0.3.tar.gz
  • Upload date:
  • Size: 12.4 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.3.tar.gz
Algorithm Hash digest
SHA256 2398e72caf6e527ad19ac87f8debc82213418e3f3702f3a9cbd23d943e3f1335
MD5 44540919e0c19d221833c87edd83a6bc
BLAKE2b-256 cea596bcb833b97d6afeca2f26114ab3763d48683c15f99d49cbd65107591e50

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airflow_provider_braze-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3bae316494714f9d8bc1fe7e2ba8f7b59f6780091a89c828f017274d5d6e8680
MD5 ef2aab08e282e8ea384791dea508473d
BLAKE2b-256 8c1decc4591adfbc47ac5456c5da209dc28590c7237fd62cbcb35aa5ef8fb2e9

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