Component workflow tokens

  An administrator role is required. For information, see User roles.

Use the Component workflow tokens page to manage tokens that are used by external workflows and applications to start component workflows. Tokens are created by publishing a workflow with a component workflow type start event.

Note: 
  • You cannot use the Component workflow tokens page to manage personal access tokens or application tokens for the API.

Note: This video was recorded using the previous user interface, so you may notice differences in the layout and menus. While the overall functionality remains the same, the user interface and navigation steps may vary slightly.

Access the Component workflow tokens page

  • Go to Settings > Environment > Component workflow tokens

View, revoke, refresh, regenerate, and delete component workflow tokens

Note: Only active tokens are available for viewing. For each component workflow, only the latest token is shown.

  1. Go to Settings > Environment > Component workflow tokens

  2. Click next to the component workflow, and then select {.} API endpoints.

    3. A dialog box appears listing the following information:

    • URL
    • URL with token
    • Token
    • Request header(s)
    • Request body
    Note: Alternately, you can open the component workflow dialog from the Workflows page. Click (Options) next to the name of the component workflow, and then select {.} API endpoints.

See Component workflow tokens fields and selections for descriptions of each field on the page.

Component workflow tokens expire after one (1) year. You can refresh the life of an existing token. After the token is refreshed, you don't have to update the token where it's called.

  1. Go to Settings > Environment > Component workflow tokens

  2. Click next to the component workflow, and then select {.} API endpoints. The Component workflow dialog is displayed.
    Note: Alternately, you can open the component workflow dialog from the Workflows page. Click (Options) next to the name of the component workflow, and then select {.} API endpoints.
  1. Click next to the Token field, and select Refresh from the menu.

    2. A message appears asking you to confirm the action.

  2. Click Refresh to confirm.

Caution: Revoking a token causes external workflows and applications that start the component workflow to fail.

  1. Go to Settings > Environment > Component workflow tokens

  2. Click next to the component workflow, and then select {.} API endpoints. The Component workflow dialog is displayed.
    Note: Alternately, you can open the component workflow dialog from the Workflows page. Click (Options) next to the name of the component workflow, and then select {.} API endpoints.
  1. Click next to the Token field, and select Revoke from the menu.

    2. A message appears asking you to confirm the action.

  2. Click Revoke to confirm.

    3. The token is revoked, invalidating its use in any API requests.

See Component workflow tokens fields and selections for descriptions fields on the page.

Component workflow tokens expire after one (1) year. The tokens of component workflows that are close to expiring or have already expired must be regenerated. Component workflows that are close to expiring will have a warning icon and workflows that have already expired will have a red error icon appearing against the workflow name to make them easily identifiable.

Caution: Regenerating a token replaces the current active token, which will be invalid in 24 hours. Regenerating a token that is revoked or expired will make the component workflow become available for external start again. Ensure to update the external workflows or applications that call the component workflow with the new token, or else they will fail.

Note: 
  1. Go to Settings > Environment.
  2. Click Component Workflow Tokens. Component workflows that are close to expiring will have a warning icon and workflows that have already expired will have a red error icon appearing against the workflow name to make them easily identifiable.
  3. Click next to the component workflow, and then select {.} API endpoints. The Component workflow dialog is displayed.
    Note: Alternately, you can open the component workflow dialog from the Workflows page. Click (Options) next to the name of the component workflow, and then select {.} API endpoints.
  1. Click next to the Token field and select Regenerate from the menu.
  2. Click Regenerate to confirm.

    3. The token becomes regenerated and the component workflow is valid for external start again.

  1. Update the new regenerated token in your application to complete the process.

Caution: Deleting a token causes external workflows and applications that use it to start the component workflow to fail.

  1. Go to Settings > Environment > Component workflow tokens

  1. Click next to the component workflow, and then select Delete.
  2. Click Delete to confirm.

    3. The token is deleted, invalidating its use in any API requests.

Note: 
  • A token with an active component workflow can be deleted. After deletion, the workflow that initiates the component workflow will not be able to start it. To resolve this, republish the component workflow or create a new token. For more information, see Regenerate component workflow tokens.
  • The delete option is available only to global administrators and automation administrators.
Selection (or column or field) Description
Workflow name

The name of the component workflow which the token belongs to.

Status

Status of token: 

  • Active: Tokens currently in use. Tokens have a lifetime of one (1) year before expiry.
  • Revoked: Tokens not active and discontinued from use.
  • Expired: Tokens that have reached more than one (1) year.

Expiry

Expiration date of the token.

Created by

Full name of the person who created the token.

(Options)

Lists the following selections:

  • API endpoints: Displays token identifier for use.
  • Delete: Deletes token from component workflow tokens.