engineer-export-api

Integrate Braze export endpoints for users, segments, campaigns, canvases, and events.

Updated Apr 6, 2026
One-click install
npx skills add https://github.com/delta-and-beta/braze-agency --skill engineer-export-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: engineer-export-api
Source: https://github.com/delta-and-beta/braze-agency/tree/main/skills/engineer-export-api
Command: npx skills add https://github.com/delta-and-beta/braze-agency --skill engineer-export-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Engineers need a cohesive, tested reference for Braze export endpoints to extract user data, segments, campaigns, canvases, and custom events efficiently.

Core Features & Use Cases

  • Centralized guidance on implementing, consuming, and debugging Braze export endpoints
  • Clear patterns for async and synchronous exports, pagination, and permissions
  • Real-world scenarios showing how to integrate with users, segments, campaigns, canvases, and events

Quick Start

Configure your Braze API client and call the export endpoints to retrieve user, segment, campaign, canvas, and event data.

Frequently Asked Questions about engineer-export-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I export user data from Braze segments using API endpoints?

To export user data from Braze segments, you use specific Braze export endpoints designed for async segment exports. This Skill provides tested patterns for these exports, including request formats, response shapes, and pagination strategies to extract data reliably.

What's the best way to handle pagination for Braze export endpoints?

The best way to handle pagination for Braze export endpoints is to apply the specific pagination strategies mapped to each endpoint type. This Skill clarifies the appropriate pagination patterns for both asynchronous segment exports and synchronous list endpoints to ensure reliable data extraction.

What is the difference between async and synchronous Braze export endpoints?

The difference between async and synchronous Braze export endpoints lies in how data is retrieved. This Skill identifies when to use asynchronous global or segment exports versus synchronous list and detail endpoints, providing implementation guides for both patterns.

How do I retrieve campaign and canvas data from Braze via API?

You retrieve campaign and canvas data from Braze via API by calling the specific export endpoints for these resources. This Skill offers real-world scenarios showing how to integrate, consume, and debug these endpoints alongside user and custom event data.

What permissions do I need to extract custom events from Braze?

Extracting custom events from Braze requires applying the appropriate permissions configured for your Braze API client. This Skill clarifies the necessary permissions and error handling needed to reliably integrate and extract custom events across various endpoints.

Why does my Braze export integration fail with response shape errors?

Your Braze export integration may fail with response shape errors if the request formats do not match the expected endpoint patterns. This Skill provides a tested implementation guide that clarifies request formats, response shapes, and error handling to speed up development.