---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Set up the First Advantage spoke

# Set up the First Advantage spoke {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 minutes to read  
Integrate the ServiceNow instance with your First Advantage account using an API key to authenticate ServiceNow
requests.

## Before you begin

* Request an Integration Hub subscription.
* Activate the First Advantage spoke.
* Role required: admin.
{#setup-first-adv__ul_l2l_mph_gfb}

## Configure a connection for the First Advantage spoke {#ariaid-title2}

Configure a connection to your First Advantage account. The First Advantage spoke connection and credential aliases use these connections to perform actions in First Advantage.

### Before you begin

Role required: admin.

Acquire the API key from the First Advantage server.

### Procedure

1. Navigate to AllProcess AutomationWorkflow Studio.
2. Click the Integrations tab.
3. Under Connections, toggle and enable the Outbound connections.
4. Locate the alias for FirstAdvantage and click View Details.  

   To manage more than one First Advantage connection record, create a new child alias record by selecting Add Connection. For more information about using multiple connections, see [Supporting multiple connections](https://www.servicenow.com/docs/D9pGgVwvfvFrzWX3lknyWg "Support several connections to a single integration provider. Select connections for flows, subflows, and actions directly from a flow.").
5. Select Configure.  
   If you are configuring the spoke for the first time, select Configure. Otherwise, select Edit.

6. On the form, fill in these fields:  
   {#create-conn-fadv__table_pxh_y3s_qdc__entry__2}

   | Field | Description |
   |-|-|
   | Connection Information ||
   | Connection Name | Name of the connection. The default and read-only name of the first record is the same as that of the connection alias. You can provide a different name when you create a connection record by clicking Add Connection. |
   | Connection URL | Option to provide the connection URL to the First Advantage server. The URL is <https://rest-ua.fadv.com>. |
   | Distribution Email | Option to provide a distribution email ID. |
   | Version | Option to provide the version of the API. |
   | Credential Information ||
   | API Key | Option to enter the API key that the First Advantage server uses to authenticate access requests. |
   [ ]

   {#create-conn-fadv__table_pxh_y3s_qdc}
7. Select Save.  
   The connection record is configured.
{#create-conn-fadv__steps_zwz_fhz_4fb}

## Create First Advantage states in your ServiceNow instance {#ariaid-title3}

Create First Advantage states to be displayed in the State list in your ServiceNow instance.

### Before you begin

Role required: admin

### Create the Draft, Ready, and In Progress states {#ariaid-title4}

Create the Draft, Ready, and In Progress states in the Task \[task\] table.

#### Before you begin

Role required: admin.

#### Procedure

1. In the Filter navigator, enter <kbd class="ph userinput">sys_choice.list</kbd>.  
   The records in the Choice \[sys_choice\] table are displayed.
2. Click New.
3. On the form, fill these values and create three records for the Draft state.  
   {#draft-inp-ready-fadv__table_z25_l1x_vkb__entry__2}

   | Field | Value |
   |-|-|
   | Table | Task \[task\] |
   | Element | state |
   | Label | Draft |
   | Value | 137 |
   [Table 1. Record 1 - Draft state]

   {#draft-inp-ready-fadv__table_z25_l1x_vkb}  
   Note:  
   * Ensure that you provide the exact numbers in the Value field as mentioned here. The spoke flows will not be triggered if there is any change in these numbers.
   * Ensure that the record is created in the Global application.
   {#draft-inp-ready-fadv__ul_dhl_zpy_vkb}
4. Click Submit.
5. Similarly, create records for the Ready and In Progress states.  
   {#draft-inp-ready-fadv__table_v1g_mdy_vkb__entry__2}

   | Field | Value |
   |-|-|
   | Table | Task \[task\] |
   | Element | state |
   | Label | Ready |
   | Value | 173 |
   [Table 2. Record 2 - Ready state]

   {#draft-inp-ready-fadv__table_v1g_mdy_vkb} {#draft-inp-ready-fadv__table_wyf_mdy_vkb__entry__2}

   | Field | Value |
   |-|-|
   | Table | Task \[task\] |
   | Element | state |
   | Label | In Progress |
   | Value | 181 |
   [Table 3. Record 3 - In Progress state]

   {#draft-inp-ready-fadv__table_wyf_mdy_vkb}  
   Note:  
   * Ensure that you provide the exact numbers in the Value field as mentioned here. The spoke flows will not be triggered if there is any change in these numbers.
   * Ensure that the record is created in the Global application.
   {#draft-inp-ready-fadv__d46762e145}
{#draft-inp-ready-fadv__steps_nkw_tbx_vkb}

#### Result

The Draft, Ready, and In Progress states are created in the Task \[task\] table

### Create the Complete and Cancelled states {#ariaid-title5}

Create the Complete and Cancelled states in the First Advantage Task
\[sn_fadv_spoke_first_advantage_task\] table.

#### Before you begin

Role required: admin.

#### Procedure

1. Navigate to AllFirst Advantage SpokeOrder Tasks.
2. Click New.  
   Note:  
   Ensure that the record is created in the First Advantage application.
3. Right-click State and click Configure Choices.
4. Perform these steps to create the Cancelled state:
   1. Enter <kbd class="ph userinput">Cancelled</kbd> in New item text.
   2. Enter <kbd class="ph userinput">149</kbd> in Numeric value.  
      Note:  
      Ensure that you provide the exact numbers in the Numeric value field as mentioned here. The spoke flows will not be triggered if there is any change in these numbers.
   3. Click Add.
   4. Click Save.
   {#add-complete-canc-fadv__substeps_oly_w2d_wkb}
5. Perform these steps to create the Complete state:
   1. Enter <kbd class="ph userinput">Complete</kbd> in New item text.
   2. Enter <kbd class="ph userinput">127</kbd> in Numeric value.  
      Note:  
      Ensure that you provide the exact numbers in the Numeric value field as mentioned here. The spoke flows will not be triggered if there is any change in these numbers.
   3. Click Add.
   4. Click Save.
   {#add-complete-canc-fadv__substeps_oxx_2fd_wkb}

#### Result

The Complete and Cancelled states are created in the First Advantage Task \[sn_fadv_spoke_first_advantage_task\] table.

### Create the Complete - Success and Complete - Deal Broken states {#ariaid-title6}

Create the Complete - Success and Complete - Deal Broken states in the First
Advantage Employee Task \[sn_fadv_spoke_first_advantage_employee_task_table\]
table.

#### Before you begin

Role required: admin.

#### Procedure

1. Navigate to AllFirst Advantage SpokeEmployee Task.
2. Click New.  
   Note:  
   Ensure that the record is created in the First Advantage application.
3. Right-click State and click Configure Choices.
4. Perform these steps to create the Cancelled state:
   1. Enter <kbd class="ph userinput">Complete - Success</kbd> in New item text.
   2. Enter <kbd class="ph userinput">161</kbd> in Numeric value.  
      Note:  
      Ensure that you provide the exact numbers in the Numeric value field as mentioned here. The spoke flows will not be triggered if there is any change in these numbers.
   3. Click Add.
   4. Click Save.
   {#add-complete-state-fadv__substeps_oly_w2d_wkb}
5. Perform these steps to create the Complete state:
   1. Enter <kbd class="ph userinput">Complete - Deal Broken</kbd> in New item text.
   2. Enter <kbd class="ph userinput">117</kbd> in Numeric value.  
      Note:  
      Ensure that you provide the exact numbers in the Numeric value field as mentioned here. The spoke flows will not be triggered if there is any change in these numbers.
   3. Click Add.
   4. Click Save.
   {#add-complete-state-fadv__substeps_oxx_2fd_wkb}
{#add-complete-state-fadv__steps_cxx_xyd_wkb}

#### Result

The Complete - Success and Complete - Deal Broken states are created in the First Advantage Employee Task \[sn_fadv_spoke_first_advantage_employee_task_table\] table.

## Set up First Advantage webhooks {#ariaid-title7}

Receive invite and order event updates at your ServiceNow
instance by setting up the webhooks.

### Before you begin

Role required: admin

### Create authorization key for the First Advantage spoke {#ariaid-title8}

Create a authorization key to authorise requests from Jenkins.

#### Before you begin

Role required: admin

#### Procedure

1. Navigate to AllSystem DefinitionScripts - Background.
2. Enter this command in the Run script (JavaScript executed on server) text field:  
   `gs.info(GlideSecureRandomUtil.getSecureRandomString(32));`
3. Click Run Script.
4. Copy and record the generated value for later use.  
{#create-authorization-key-first-advantage__steps_mcx_5wd_s2c}

### Provide key in your ServiceNow instance {#ariaid-title9}

Set up the First Advantage webhook by providing key for the First Advantage webhook client.

#### Before you begin

* [Create authorization key for the First Advantage spoke](https://www.servicenow.com/docs/M_c4jRRu4ro0NLLWTvBpew#create-authorization-key-first-advantage "Create a authorization key to authorise requests from Jenkins.") and record the value.
* Role required: admin
{#add-fadv-key__ul_qxk_yq2_wkb}

#### Procedure

1. Navigate to AllFirst Advantage SpokeFADV Webhook Client Details.
2. Click New.
3. On the form, fill these values.  
   {#add-fadv-key__table_gx1_fr2_wkb__entry__2}

   | Field | Description |
   |-|-|
   | Name | Name to uniquely identify the record. |
   | Authorization Key | Authorization key you had generated. For more information, see [Create authorization key for the First Advantage spoke](https://www.servicenow.com/docs/M_c4jRRu4ro0NLLWTvBpew#create-authorization-key-first-advantage "Create a authorization key to authorise requests from Jenkins."). |
   [ ]

   {#add-fadv-key__table_gx1_fr2_wkb}
4. Click Submit.

### Access API endpoints {#ariaid-title10}

Access the API endpoint for the invite and order events and share the required
details with First Advantage to set up the webhooks.

#### Before you begin

Role required: admin

#### Procedure

1. Navigate to AllSystem Web ServicesScripted REST APIs.
2. Open the record for the First Advantage spoke, for example, First Advantage Webhook.
3. In the Resources tab:
   1. Open the record for the invite event, for example, Invite Status.
   2. Copy and record the path provided in Resource path, for example, <kbd class="ph userinput">/api/sn_fadv_spoke/fadv/invite_status</kbd>.
   3. Open the record for the order event, for example, Order Status.
   4. Copy and record the path provided in Resource path, for example, <kbd class="ph userinput">/api/sn_fadv_spoke/fadv/order_status</kbd>.
   {#conf-api-fadv__substeps_cyb_md2_wkb}
{#conf-api-fadv__steps_gft_kr2_wkb}

#### What to do next

Contact First Advantage to setup webhooks for your ServiceNow instance. For this, share these details with First Advantage:

* Custom header in this format: <kbd class="ph userinput">fadvKey &lt;authorization-key&gt;</kbd>.  
  Note:  
  * Ensure that the custom header is in this format only. The spoke flows will not be triggered if there is any change.
  * Provide the same key you had earlier provided in First Advantage SpokeFADV Webhook Client Details.
  * Use the same case as mentioned here: <kbd class="ph userinput">fadvKey</kbd>.
  {#conf-api-fadv__ul_kfx_lvc_ykb}
* API endpoint for the invite events in this format: <kbd class="ph userinput">&lt;ServiceNow-instance-URL&gt;/api/sn_fadv_spoke/fadv/invite_status</kbd>
* API endpoint for the order events in this format: <kbd class="ph userinput">&lt;ServiceNow-instance-URL&gt;/api/sn_fadv_spoke/fadv/order_status</kbd>
{#conf-api-fadv__ul_jgh_5d2_wkb}

## Synchronise First Advantage accounts and packages with ServiceNow {#ariaid-title11}

Store the details of the First Advantage accounts and packages by synchronizing First Advantage accounts and packages with ServiceNow.

### Before you begin

Role required: First Advantage admin

### Procedure

1. Navigate to AllFirst Advantage SpokeAccounts.
2. Click New.
3. On the form, fill in the values.  
   {#sync-packages-fadv__table_hhk_nzk_ynb__entry__2}

   | Field | Description |
   |-|-|
   | Primary Account | Option to specify that the account is a primary account. Select the check box. |
   | Account ID | ID of the primary account. |
   | Account Name | Name of the primary account. |
   [Table 4. Account form]

   {#sync-packages-fadv__table_hhk_nzk_ynb}
4. Click Submit.  
   The primary account is created and the record is displayed.
5. Navigate to First Advantage SpokeAccounts.
6. Click the Get Accounts related list.
7. Navigate to First Advantage SpokePackages.
8. Click the Get Packages related link.
{#sync-packages-fadv__steps_evy_h1l_ynb}

### Result

The First Advantage account and package details are retrieved.  
Note:  
Only users with the FADV admin role can synchronize the account and package details. Users with FADV user role can only view the retrieved details.

*[\>]: and then