API Endpoint

API Endpoint allows you to create a flow that is activated via a URL.

Only GET and POST request methods are supported. Other request methods, such as HEAD, are not supported by this function card.

Input

No input fields.

Output

Output fields for the API Endpoint card are created by the user. There are three categories of output fields associated with the API Endpoint card:

  • body

    • Creating output fields beneath this header allows you to access values contained within the body of the HTTP request. This is commonly used when activating a flow via a POST HTTP request.
  • headers

    • By creating output fields named explicitly (such as 'content-type'), you can access the values contained within the HTTP request header. IMPORTANT: since headers are normally case insensitive, you must enter the header keys you want to capture in all lowercase.
  • query

    • Any parameters sent within the URL string, such as http://example.com/example?name=john, can be accessed by creating fields named after the query parameter. In this example, you could create the field "name" to get access to the value contained within this field.
    • Do not use parameters prefixed with x-okta-workflows to pass data to the rest of a flow when using an API endpoint. You may find that this prefix is not available for use.

Related topics

Functions in Workflows

About the elements of Okta Workflows