Connector Builder custom API card documentation

Reference help for custom API action cards

Include a reference help topic for the Custom API Action card for your connector.

Use the following sentence to introduce your topic:

  • Use the Custom API Action to make an authenticated custom API request to the <your service> REST API.

Options

For the Request Type field in your help topic, specify the methods supported by your Custom API Action card. Use these definitions as needed:

GET Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content.
POST Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.
PUT Sends data to be stored at a specific location on a web server based on parameters (for example, uploading a file). Unlike POST requests, PUT requests are idempotent. For successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, a 200 (OK), 201 (Created), or 204 (No Content) response message is returned.
PATCH Applies partial modifications to a resource on a web server based on parameters. PATCH isn't idempotent. Multiple PATCH requests could have unintended consequences. If a PATCH is successful, a 200 (OK) or 204 (No Content) response message is returned.
DELETE Deletes the specified resource (if it exists) from the web server based on parameters. If a DELETE is successful, a 200 (OK) response message is returned.

Inputs

For the input fields section, provide definitions for the following fields:

  • Relative URL

  • Headers

  • Query

  • Body

As an example, here's a definition for the Relative URL field on the Google Calendar connector:

Relative URL

URL address of the web server where you're attempting to interact. Specify the relative URL as /{version}/{insert_remaining_URL}.

You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input.

For example, the Google Calendar API endpoint is: https://www.googleapis.com/calendar/v3/users/{userId}/calendarList so the relative URL is: /v3/users/{userId}/calendarList.

Outputs

For the output fields section, provide definitions for the following fields:

  • Status Code

  • Headers

  • Body

For example, for the Status Code field:

Status Code

Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:

  • A 201 Created status code indicates success where a new resource was created.

  • A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Examples

For reference, see these Custom API Action card topics: