Brazen Developer Resources

Brazen Developer Resources

Welcome to the hub for Brazen developer tools! Here you'll find comprehensive guides and API reference documentation to help you start integrating with Brazen as quickly as possible. These guides contain step-by-step instructions on how to set up Brazen integrations, including: custom registration experiences through SSO and our API, syncing data with outgoing webhooks, importing job postings with job feeds, and connecting with other enterprise applications. If you get stuck, help is always an email away at developers@brazen.com. Let's build something cool!

Get Started    API Reference

Push Contacts

About

Our Push Contacts feature allows your enabled ATS or CRM to receive contact data captured by Brazen Connect through events and Quickchats. We'll push over a new contact as soon as we capture even the most basic info and then we'll continue to post updates as they interact with your organization through Brazen.

Contact Field Mapping

When Brazen pushes contacts to your system, up to three sets of data points can be included:

  1. Standard fields which your system already knows how to handle
    • Examples: first name, last name, email address
  2. Key metrics describing your organization's interactions with the individual on the Brazen platform
    • Examples: Brazen Last Chatted With, Brazen Chat Outcome
  3. Custom mappings you define which map data captured by your Brazen event registration forms to custom fields you've created in your system


Option 1

Discrete Value Fields

Some of the contact information which Brazen can send your system is modeled with discrete values. Knowing the possible values can help you model this data in your system.

Brazen Source

Brazen Job Landing Page
CSV
Event
Plugin
Talroo

Brazen Conversion Type

Event
Job
Failed Event Pre-Screen
Failed Job Pre-Screen
Waitlisted

Brazen Chat Outcome

If you use the "Next Steps" chat rating system

Interview
Screen
Pipeline
Not a fit
(N/A) Did not chat

If you use the "Star Ratings" system

5 stars
4 stars
3 stars
2 stars
1 stars

Supported Applications

iCIMS

Integrated system: Person Profile API

Merge behavior: Whenever a contact is posted to iCIMS, all available Brazen data is merged with your existing iCIMS contact record. Brazen-specific fields will be updated, but standard fields will never be overwritten when existing data is present.

Below is an example iCIMS contact post, including all standard fields and a few custom fields.

{
    "addresses": [{
        "addresscity": "Arlington",
        "addresscountry": {"value": "United States"},
        "addressstate": {"value": "VA"}
    }],
    "email": "richard@example.com",
    "field26488": "Event",
    "field26489": "May Open House",
    "field26490": "2019-05-01",
    "field26491": "russ.hanneman@example.com",
    "field26492": "https://help.linkedin.com/app/answers/detail/a_id/85/~/promoting-your-public-profile",
    "field26493": "Event",
    "field26494": "2019-05-01",
    "field26495": "Interview",
    "firstname": "Richard",
    "lastname": "Hendrix",
    "phones": [{"phonenumber": "+15555555555"}]
}

SmashFly

Integrated system: Contact Import API

Merge behavior: SmashFly does not support contact merging—whenever a contact is posted to SmashFly, all available Brazen data is sent, overwriting any previous values in SmashFly. When Brazen doesn't have data for a given field, that field is not sent and therefore doesn't overwrite any existing value.

Below is an example SmashFly contact post, including all standard fields and a few custom fields.

{
  "Contact": {
    "City": "Arlington",
    "Email": "jared@example.com",
    "FirstName": "Jared",
    "LastName": "Dunn",
    "Phone": "+15555555555",
    "ProfileURL": "https://help.linkedin.com/app/answers/detail/a_id/85/~/promoting-your-public-profile",
    "State": "VA",
    "UDF": [
      {
        "FieldName": "MediumTextField1",
        "Values": [
          "May Open House"
        ]
      },
      {
        "FieldName": "DateField1",
        "Values": [
          "05/01/2019 12:00"
        ]
      },
      {
        "FieldName": "ShortTextField1",
        "Values": [
          "Event"
        ]
      },
      {
        "FieldName": "ShortTextField2",
        "Values": [
          "dinesh@piedpiper.com"
        ]
      },
      {
        "FieldName": "ShortTextField3",
        "Values": [
          "Event"
        ]
      },
      {
        "FieldName": "DateField2",
        "Values": [
          "05/01/2019 13:15"
        ]
      },
      {
        "FieldName": "ShortTextField4",
        "Values": [
          "INTERVIEW"
        ]
      }
    ]
  },
  "ContactDBId": 45,
  "Password": "[removed]",
  "UserName": "[removed]"
}

Lytics

Integrated system: Data Upload API

Merge behavior: Lytics does not support contact merging—whenever a contact is posted to Lytics, all available Brazen data is sent, overwriting any previous values in Lytics. When Brazen doesn't have data for a given field, that field is not sent and therefore doesn't overwrite any existing value.

Below is an example Lytics contact post, in which all fields are considered "custom". Add fields with matching names in Lytics to see their values.

{
    "Are you willing to relocate?": "No",
    "Brazen Conversion Description": "May Open House",
    "Brazen Conversion Type": "Event",
    "Brazen Source": "Event",
    "Certifications/Licenses": "Driver's License",
    "City": "Arlington",
    "Country": "US",
    "Created Date": "05/01/2019",
    "Date Available": "Today",
    "Email": "gbelson@hooli.com",
    "First Name": "Gavin",
    "Headline": "CEO",
    "Highest Education Level": "Masters Degree",
    "Last Name": "Belson",
    "Mobile Number": "+15555555555",
    "State or Province": "VA",
    "What types of positions are you looking for?": "All of them"
}

Talemetry

Integrated system: Integration Service API

Merge behavior: Data sent to Talemetry will be sent with Brazen as its source. Data sent from Brazen will have no effect on any contact information provided to Talemetry from any other source.

Below is an example Talemetry contact post, including all standard fields and supported custom fields.

<?xml version="1.0" encoding="UTF-8"?>
<Candidates>
   <Candidate>
      <UserArea>
         <IntegrationExternalID>BZ100</IntegrationExternalID>
         <ClientName>1234</ClientName>
         <IntegrationFields>
            <Candidate xmlns="http://ns.hr-xml.org/2007-04-15">
               <CandidateRecordInfo>
                  <Id name="Applid">BZ100</Id>
               </CandidateRecordInfo>
               <Resume>
                  <StructuredXMLResume>
                     <ContactInfo>
                        <PersonName>
                           <GivenName>Nelson</GivenName>
                           <FamilyName>Bighetti</FamilyName>
                        </PersonName>
                        <ContactMethod>
                           <Telephone>
                              <FormattedNumber>1-555-555-5555</FormattedNumber>
                           </Telephone>
                           <InternetEmailAddress>nbighetti@example.com</InternetEmailAddress>
                           <PostalAddress>
                              <CountryCode>US</CountryCode>
                              <Region>VA</Region>
                              <Municipality>Arlington</Municipality>
                           </PostalAddress>
                        </ContactMethod>
                     </ContactInfo>
                  </StructuredXmlResume>
               </Resume>
               <UserArea>
                  <brazen_conversion_type>Event</brazen_conversion_type>
                  <brazen_last_chatted_date>2019-08-05</brazen_last_chatted_date>
                  <brazen_chat_outcome>Interview</brazen_chat_outcome>
                  <brazen_chatted_with>gbelson@example.com</brazen_chatted_with>
                  <brazen_source>Event</brazen_source>
                  <brazen_created_date>2019-08-05</brazen_created_date>
                  <CustomFields xmlns="">
                     <CustomField>
                        <name>CandidateSource</name>
                        <value>brazen_resume_db</value>
                     </CustomField>
                  </CustomFields>
               </UserArea>
            </Candidate>
         </IntegrationFields>
      </UserArea>
   </Candidate>
</Candidates>

Push Contacts


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.