Scheduled Automations

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

Scheduled custom automation

1. In the side menu, go to API, then select Automations.
2. Choose API Scheduled Automation.
3. Fill out the Automation form:
   • Name - Enter a name for your automation.
   • API - Select the API you want to attach the automation to.
   • Description - Provide a brief description of the automation.
   • Scheduled rate minutes: The frequency at which the automation 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 automation parameters.
   • (Optional) Headers - Specify headers to be sent with automation requests by adding key/value pairs
4. Click Submit.

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

Scheduled managed automation

1. In the side menu, go to API, then select Automations.
2. Choose API Scheduled Automation.
3. Fill out the Automation form:
   • Name - Enter a name for your automation.
   • API - Select the API you want to attach the automation to.
   • Description - Provide a brief description of the automation.
   • Scheduled rate minutes: The rate in minutes at which the automation should be run.
   • Integration Type - Choose Managed.
   • Select which managed automation you want to use. Learn about each managed automation 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 automation requests by adding key/value pairs.
   • API URL/Endpoint - The API base URL or Endpoint to test.
4. 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.