API scheduled actions

API scheduled actions allow you to automate checks or processes that run at regular time intervals against specific APIs. You can configure either custom actions or use predefined managed actions depending on your needs.

Scheduled custom action

1. Navigate to Inventory and select the APIs tab.
2. Select the API you want to create the action for.
3. Click Actions, then Create Action.
4. Choose Scheduled action.
5. ‍Fill out the Action form:
   • ‍Name – Enter a name for your action.
   • ‍Description – Provide a brief description of the action.
   • ‍Scheduled rate minutes: The frequency at which the action should run.
   • ‍Integration Type – Choose Custom.
   • (Optional) Select an existing Auth provider or click Create to set up a new one. Learn more about Auth providers here.
   • ‍Integration - Choose a previously created Lambda or Webhook integration, or create a new one.
   • (Optional) Context – Click Add key to add key/value pairs for action parameters.
   • (Optional) Headers - Specify headers to be sent with action requests by adding key/value pairs
6. Click Submit.

When your custom integration is triggered, FireTail will send a JSON payload to your chosen integration. View the Custom API action integration example.

Scheduled managed action

1. Navigate to Inventory and select the APIs tab.
2. Select the API you want to create the action for.
3. Click Actions, then Create Action.
4. Choose Scheduled action.
5. ‍Fill out the Action form:
   • ‍Name – Enter a name for your action.
   • ‍Description – Provide a brief description of the action.
   • ‍Scheduled rate minutes: The rate in minutes at which the action should be run.
   • ‍Integration Type – Choose Managed.
   • Select which managed action you want to use. Learn about each managed action here.
   • (Optional) Auth provider - Select an existing Auth provider or click Create to set up a new one. Learn more about Auth providers. 
   • (Optional) Headers - Specify headers to be sent with action requests by adding key/value pairs.
   • ‍API URL/Endpoint - The API base URL or Endpoint to test.
6. Click Submit.

Additional settings for API contract testing:

• ‍Use event specification:
  
  • Enable to use the specification generated from the triggering event for validation.
  • Switch off to use a predefined API specification.
• ‍API Specification:The API specification to be used during contract testing. This will be used when Use Event Specification is toggled off, or if no event specification exists.