Using the Extension

The extension popup can be opened and closed using the keyboard shortcut Ctrl+Shift+E (or Cmd+Shift+E for Mac)

Sending a Webhook

Once you have created an action, the extension popup will open to the Send tab, selecting the first action where your current URL matches with the URL RegEx pattern. From this tab, you can modify the form as needed and send a webhook to FlexDeploy.

  • Select a different action in the dropdown, if the action wasn’t automatically set correctly.
  • Update the webhook URL as needed.
  • Enter values for any properties not already filled in.
    • For single item properties, simply enter the correct value in the input field.
    • For list data properties, select whichever option(s) in the dropdown you would like sent with the payload. Additionally, you can type a new option and click Enter to add and select a new option.

After reviewing, click Send Webhook to send the payload to FlexDeploy. After receiving a response, the result will be indicated with a  for a valid response or awith the error message for a failed response. You can check the console logs for more details after a failed response.

Check the incoming webhook messages page in your FlexDeploy instance to see how the webhook was received and processed.

Creating/Updating an Action

From the My Actions tab, you can create and configure your own actions which will define the content being sent to FlexDeploy. Each action will be linked to some webhook URL defined by you, so you could have different actions for each webhook function you want to run in FlexDeploy.

Actions are saved in the browser’s local storage, so actions will be cleared whenever browsing data is cleared.

Action Details

NameDescription
NameName to identify your action
Base ActionTechnology template to use, which will add some technology-specific properties to the action and set a URL match pattern. Currently, base actions are available for Oracle APEX, ORDS, OIC, and OBIEE.
Webhook URLFull URL to send to FlexDeploy. This will be in the format <FlexDeploy base URL>/flexdeploy/webhooks/v1/<webhook function URI>.
URL Match Pattern

A regular expression to determine when the extension should default to this action when the popup is opened. For help generating an expression, see regex101: build, test, and debug regex.

Example: .*\/apex\/f.* for an APEX action

PropertiesDefine any additional information you want to send along with your webhook. See more details in the table below.

Properties

NameDescription
NameName for your property.
Data TypeOptions are single item or list data. All values are sent as string.
Default Value Type

Literal - Literal text

Selector - A CSS selector to derive the property’s value from page content.

Javascript - A Javascript statement, or multiple statements, for deriving the property’s value. The last statement must return the value.

Default ValueThe literal text, selector, or Javascript to be used for finding the default value.
SubfieldOptionally, provide a subfield for the value for each list item.