Public API Lead Source

Quick Reference Keywords: Public API · API keys · Create lead via API · Journey rules · Submission history

Overview

The Public API lead source lets external systems create contacts and opportunities in brayv.ai using authenticated API requests. Configure it at Settings → Lead Sources → Public API (or choose Public API from Add New Source on the Lead Sources hub). See API documentation for more information.

Tabs

API Keys

1. Click Create Key
2. Enter a name (e.g. Angi, Partner CRM)
3. Copy the secret immediately — it is shown once
4. Use Revoke when a key should no longer work

Store keys in your server or secret manager. Never put them in client-side website JavaScript.

Journey Rules

• Toggle Add to Customer Journey when API submissions should create opportunities
• Configure Journey Rules and a Default Journey (same pattern as other lead sources)
• Click Save Changes

Notifications

• Enable Notifications for new API submissions
• Choose In-App Notifications and/or Email Notifications
• Save Changes

Assignment

Optional contact-owner routing using the same assignment script builder as webhooks and forms:

• Set Up Assignment Rules / Edit Rules
• Test Script and View Flow Chart
• Save Changes

See Lead Assignment for how to write and test assignment rules.

Submission History

Browse recent API submissions and open the created contact with View contact.

Typical Setup Flow

1. Create an API key and store it securely
2. Configure journey rules (which journey new leads enter)
3. Optionally enable notifications and assignment
4. Point your integration at the brayv public lead API using the key
5. Verify a test payload appears under Submission History

Related

• Prefer Webhooks when the other system can POST without custom code
• Prefer Forms for website capture without an API