Configure External API Web Services

Before custom forms can be configured to use external API endpoints, the web service must first be set up.

  1. Navigate to the Settings > API Configuration > External APIs area.

  2. Select the Add external API button.

  3. In the Add External API screen, provide the following information.

    1. External API name - Provide a name for the API to identify it in GrantsConnect.

    2. Description - Include a brief description of the API, how it will be used, etc.

    3. Host URL (HTTPS only) - Provide the endpoint.

    4. HTTP method - Specify whether the method is GET or POST. This will depend on how the API was built.

      Tip: For POST methods, a JSON post-body template can be included to specify what information GrantsConnect will send to the endpoint (e.g., Host URL). For example, this template will send Email, First Name, Last Name, and SSO ID - {"email":"{{EMAIL}}","firstName":"{{FIRST_NAME}}","lastName":"{{LAST_NAME}}","SSOID":"{{SSO_ID}}"}

    5. Authentication type - Choose how GrantsConnect will authenticate against the API, including sending usernames and API keys.

    6. Response Fields - Specify what fields the endpoint will respond with, allowing the forms to use individual parts of the response from the endpoint.

      Tip: These are fields that will be used on custom Applicant forms. External API form fields should be created after building the web service, matching the fields specified in this section. Learn more.

    7. Additional Headers - Provide additional headers, if any.

  4. Save all changes to add the web service.

Note: Examples of configurations for specific scenarios can be found here.