Create a Callout Integration

Administrators can create a callout integration setting to send and receive data from a third-party API.

Create Callout Integration Setting

  1. In the tab bar, click App Launcher, or in Salesforce Classic, click   Nimble AMS, Staff View, Button, All Tabs
    .
  2. Click Integration Settings.
  3. Click New.

  4. In Record Type, select Callout.

  5. In Name, enter a name in pascal case to identify the integration.
  6. In Description, enter a description you can reference to understand the integration setting's purpose.
  7. In Authentication Key, enter a secure authentication key. 

    We recommend using a unique 256-bit WEP authentication key for each integration setting. You can generate a random key, using a random key generator such as Random Key Generator (external).

  8. In Class, enter the name of the Apex class that implements the callouts to the third-party API.

    You should create a new Apex class for each callout integration setting. An Apex class can be created through development effort.

  9. Statusis populated.

  10. If you want to record log detail for the integration setting, in Logging Levelselect the log detail level. More information about the level of detail stored can be found on the Understanding Logging Level page.

  11. To set the number of days the integration callout is retained within Nimble AMS, set the Archive Schedule Information:

    1. In Archive Format, enter the Apex scheduler expression. This field controls the frequency with which the archiving scheduled job is executed. See Apex Scheduler (external) to learn more about Apex schedules.

    2. In Archive Completed Storage Days, enter the number of days the integration callouts with a Status of Completed will be retained. 

    3. In Archive Failed Storage Days, enter the number of days the integration callouts with a Status of Failed will be retained.

    4. Deselect Archive Active.

      The archiving scheduled job must be created before it is activated. Any changes to the archiving scheduled job must be made while the archiving job is inactive.

  12. Click Save.

  13. Click Edit.

  14. Select Archive Active.

  15. Click Save.

Create Callout Integration Parameters

Administrators must create integration parameters so the integration callout worker can communicate with the third-party API. Administrators can reconfigure an integration parameter at any time to match any changes with the third-party API.

  1. In the tab bar, click App Launcher, or in Salesforce Classic, click   Nimble AMS, Staff View, Button, All Tabs
    .
  2. Click Integration Settings.
  3. Select a list view—like All—and click Go!
  4. Click the name of the integration setting to which you want to add an integration parameter.
  5. From the Inbound Integration Settings related list, click New Integration Parameter.

  6. Integration Setting is populated

  7. In Key, enter a word, or words, that identify the integration callout Apex class will use to retrieve to the Value.

  8. In Value, enter the text to be used in the integration callout Apex class when the Key is referenced. 

  9. Click Save.

Create Integration Callout Worker

  1. In the tab bar, click App Launcher, or in Salesforce Classic, click   Nimble AMS, Staff View, Button, All Tabs
    .
  2. Click Integration Settings.
  3. Select a list view—like All Callout Integrations—and click Go!
  4. Click the name of the integration setting to which you want to add an integration callout worker.
  5. From the Integration Callout Workers related list, click New Integration Callout Worker.

  6. Integration Setting is populated.

  7. In Worker Schedule, enter the Apex scheduler expression. This field controls the frequency with which the integration callout worker is executed. See Apex Scheduler to learn how to configure this field.

  8. Deselect Worker Active.

    The integration callout worker must first be created before it is activated. Changes to the integration callout worker must be made while the integration callout worker is inactive.

  9. Click Save.

  10. Click Edit.
  11. Select Worker Active to activate the integration callout worker.

  12. Click Save.

Create Integration Response Worker

  1. In the tab bar, click App Launcher, or in Salesforce Classic, click   Nimble AMS, Staff View, Button, All Tabs
    .
  2. Click Integration Settings.
  3. Select a list view—like All Callout Integrations—and click Go!
  4. Click the name of the integration setting to which you want to add an integration response worker.
  5. From the Integration Response Workers related list, click New Integration Reponse Worker.

  6. Integration Setting is populated.

  7. In Worker Schedule, enter the Apex scheduler expression. This field controls the frequency with which the integration response worker is executed. See Apex Scheduler to learn how to configure this field.

  8. In Worker Batch Size, enter the number of integration callouts with a Status of Pending theintegration response worker will processes at a time.

  9. Deselect Worker Active.

    The integration response worker must first be created before it is activated. Changes to the integration response worker must be made while the integration response worker is inactive.

  10. Click Save.

  11. Click Edit.
  12. Select Worker Active to activate the integration response worker.

  13. Click Save.

On This Page

In This Section