Make API Call activity

Request

• URI: Enter the URI of the external API endpoint. The URI must start with a protocol prefix, such as http:// or https://

  You can use the Insert token button to include variables in the URI, as needed. When the workflow runs, tokens are replaced with their value.

• Method: Select the HTTP method that will be used for the API call. This defines the type of action the request will perform on the specified URI. Choose from:
  • GET
  • POST
  • PATCH
  • PUT
  • DELETE
• Header (optional): Add any additional request headers, as needed. The default Content-Type: application/json header is added automatically.
• Body (optional): Depending on the selected method, enter the request body, if needed.

Connection

• Authorization Type: Select the option that matches the security requirements of the external API that you are connecting to. Choose from:
  • None: Choose this option if the API does not require any authentication or authorization.
  • OAuth2: Choose this option if the API uses OAuth 2.0 protocol for secure authorization, typically involving an access token obtained through an OAuth flow.
  • Token: Choose this option if the API requires a static token for authentication.

Outputs

The Outputs tab lists the outputs that will be available as variables in downstream workflow activities. These are the standard outputs:

• Status code
• Response body
• Response headers

To add outputs, you can upload a sample response payload to identify custom single-value outputs and make them available for use in subsequent workflow steps.

Example

Summary: The exact settings that are required to configure the Make API Call activity will vary depending on the external API that you are connecting to. The Make API Call activity accommodates various HTTP methods, custom headers, and payloads for versatile applications. Embedding API calls reduces manual effort and improves operational efficiency within workflows.

This example shows how to send a POST request to the Jira API to create a new Jira ticket.

Step 1: Configure the request details

• URI: Enter a URI that points to your Jira instance and the specific API endpoint, for example: https://example.atlassian.net/rest/api/3/issue/
• Method: Select POST to send the necessary ticket information to your Jira instance.
• Body (optional): Use JSON in the request body to reference the Jira project key and fields, for example:

  {
    "fields": {
        "project":
        {
          "key": "TEST"
        },
        "summary": "Data quality issue",
        "description": "A data quality issue has been raised in Data Integrity Suite.",
        "issuetype": {
          "name": "Bug"
        }
    }
  }

  This creates a new Jira bug in the "TEST" project, with a summary and description that matches the information included in the request body.

Step 2: Configure the connection

• Authorization Type: Select the appropriate authorization method based on your Jira instance's security configuration. Depending on the choice, you'll need to provide specific credentials or tokens.

  • None: No additional information is required. Use this only if your Jira instance does not require authentication (rare).

  • Token: Provide a static API token or personal access token to authenticate your requests. For Jira Cloud, you can generate a personal access token from your Atlassian account under "Security" settings. Store your token securely as it grants access to your Jira resources.
    Note: Ensure that the token has the necessary permissions to perform the API actions you require.

  • OAuth2: If you choose this option, you will need to set up an OAuth 2.0 client in Jira and obtain the following:

    • URI: The authorization server's endpoint URL where the OAuth2 authorization request is sent. This is typically provided by your OAuth provider or Jira's OAuth configuration.
    • Client ID: The unique identifier assigned to your application during OAuth client registration. It tells the authorization server which application is requesting access.
    • Client secret: The secret key associated with your OAuth client registration. It is used to authenticate your application with the authorization server and should be kept secure.
    • Scope: The permissions or access levels that your application is requesting. For example, in Jira, this might include permissions like read:issue or write:issue.
      Note: OAuth setup might require coordination with your Jira administrator or OAuth provider.