Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

There are three types of Actions that can be used with their respective trigger types: order, vendor, and asset. Available Action options are filtered based on the type of Trigger selected.

Order Actions

Create Jira Issue

Purpose: Allows the user Image Added

The Create Jira issue action allows Automation to create an issue of a specified issue type in a specified project.

Available for Triggers:

  • Order Triggers

  • Vendor Triggers

  • Asset Triggers

Administrator must specify a Summary along with any other custom fields which are required for the issue type in the project they are creating.

The create issue action also comes with the Add additional metadata checkbox. This feature will be used to surface Checkout information on linked tickets, but the components to show the information are still under development.

Edit request Issue

Purpose: Image Added

The Edit request issue action allows users Automation to modify fields on the request action.

Available for trigger types:

  • Order Triggers

Details:

This automation action works very similarly to the Create issue action. Administrators can use the Edit issue action to set custom fields on a ticket once the rule is triggered.

Create request comment

Image Added

The Create request comment action allows Automation to automatically comment on the Order Issue that triggered this rule. Administrators can set the comment to be public or internal. The comment will be made as the user Checkout.

Send WebhookPurpose: Sends a webhook to Image Added

Decline order items

Image Added

The Decline order items action allows Automation to decline all items in an order.

Image Added

Disable submit/fulfill order button

Image Added

The Disable submit/fulfill order button action allows Automation to disable the Submit Order button on a ticket to prevent the agents from generating a purchase order to send to the Vendor.

Image Added

Enable submit/fulfill order button

Image Added

The Enable submit/fulfill order button action allows Automation to enable the Submit Order button on a ticket to allow the agents to generate a purchase order.

Send Webhook

Image Added

The Send Webhook action allows Automation to connect to a webhook through a URL when the automation rule is triggered.

Available for trigger types:

  • Order Triggers

  • Vendor Triggers

  • Asset Triggers

Details:

Administrators can set up a webhook to fire when the automation rule is triggered. The following information is required:

  • HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD)

  • Webhook URL

Administrators can also define custom headers for authentication purposes or other custom requirements.

If the HTTP method is POST or PUT, the body will be a JSON containing the Checkout Order information.

Example:

Code Block
{
  "items": [
    {
      "itemId": 307,
      "quantity": 1,
      "price": 229.99,
      "itemTitle": "Portable SSD T7 TOUCH USB 3.2 1TB (Black)",
      "itemDescription": "SSD with fingerprint and password security",
      "vendorId": 194,
      "type": "PRODUCT",
      "status": "NEW",
      "items": null,
      "backFill": false
    }
  ],
  "unlistedItemRequests": []
}

Additionally, if the trigger for the rule is Order Updated or Asset Updated, the JSON body will contain a changelog property.

The changelog for orders have a few different formats depending on what happens. If an item or unlisted item request is added or removed by an agent, then the changelog will look similar to this:

Code Block
  "changelog": {
    "order details": {
      "total": {
        "from": 10746.99,
        "to": 10646.99
      }
    },
    "items": [
      {
        "name": "Toshiba Canvio Flex",
        "action": "DELETED",
        "item": {
          "items": null,
          "itemId": 20214,
          "quantity": 1,
          "price": 100,
          "itemTitle": "Toshiba Canvio Flex",
          "itemDescription": "Large portable HDD from Toshiba",
          "vendorId": 3159,
          "type": "PRODUCT",
          "status": "NEW",
          "backfillQuantity": null,
          "creatorRole": "SERVICEDESK_AGENT",
          "backFill": false
        }
      }
    ]
  }

However, if an item or unlisted item is edited, or the order details are edited, then it may look more like this:

Code Block

Send Slack Message

Purpose: Sends
"changelog": {
    "order details": {
      "total": {
        "from": 16046.99,
        "to": 21145.99
      },
    },
    "items": [
      {
        "name": "Apple iPhone 11 Pro",
        "action": "MODIFIED",
        "price": {
          "from": 999,
          "to": 500
        }
      },
      {
        "name": "Apple Macbook Pro 16\" - Space Grey",
        "action": "MODIFIED",
        "quantity": {
          "from": 1,
          "to": 3
        }
      }
    ]
  }

The asset data changelog will be a similar format to when an item has been modified.

For example:

Code Block
  "changelog": {
    "serialNumber": {
      "from": "1234",
      "to": "123456"
    },
    "98d8bdac-7ced-4c88-8454-8029563fee91": {
      "from": null,
      "to": "5f0f341bce15e800264bf95d"
    },
    "9e9109c4-fcc2-4723-8c61-5320b05ae80a": {
      "from": null,
      "to": "123"
    },
    "dateAssigned": {
      "from": null,
      "to": "2024-05-24"
    }
  }


To extract Checkout webhook datawith Jira automation, see our how-to article here!

Send Slack Message

Image Added

The Send Slack Message action allows Automation to send a Slack message to a specific channel when the rule is triggered.

Available for trigger types:

  • Order Triggers

  • Vendor Triggers

  • Asset Triggers

    Details:

    The administrators will need to provide the following:

    • Webhook URL (Incoming Slack URL)

    • Message

    • Channel or User

    Information about setting up the integration on the Slack side can be found here.

    Transition Issue

    Purpose: Allows the user

    Image Added

    The Transition issue action allows Automation to transition the issue from one status to another.

    Available for trigger types:

    • Order Triggers

    Details:

    Administrators can choose which status the issue will be transitioned to when the Checkout automation rule is triggered.

    Image Removed

    Screen Shot 2024-03-08 at 12.00.12 PM.pngImage Added

    The transition will still respect any validators or conditions present on a transition.

    Create request comment

    Purpose: This action allows admins to put automated comments on a ticket when triggered.

    Available for Trigger Types:

    • Order Triggers

    Details:

    • Administrators can customize a comment which will be left on the ticket when the automation rule is triggered.

    • The comment will be made as the user Checkout.

    • Administrators can choose whether the comment is Internal or an External.

    Image Removed

    Decline order items

    Purpose: Decline all items in an order.

    Available for trigger types:

    • Order Triggers

    Disable submit order button

    Purpose: Disable the Submit Order button to prevent the agents from generating a purchase order to send to the Vendor.

    Available for Trigger Types:

    • Order Triggers

    Enable Submit Order Button

    Purpose: Enable the Submit Order button on a ticket to allow the agents to generate a purchase order.

    Available for Trigger types:

    • Order Triggers

    Edit asset attributes

    Purpose: Allows administrators

    Approve issue as Checkout addon

    Image Added

    The Approve issue as Checkout addon action allows Automation to approve an issue.

    Image Added

    Vendor Actions

    Create Jira Issue

    (see above)

    Send webhook

    (see above)

    Send Slack message

    (see above)

    Asset Actions

    Create Jira Issue

    (see above)

    Edit asset attributes

    Image Added

    The Edit asset attributes action allows Automation to customize asset attributes when the automation rule is run.

    Available for trigger types:

    • Asset Triggers

    Details:

    triggered.

    This action can set values for asset attributes when run. Status, Vendor, and User Picker attributes are not supported.

    Send webhook

    (see above)

    Send Slack message

    (see above)

    Table of Contents

    Write into our Support Desk with any questions you have.

    Enjoying Checkout? Leave us a review!