# Okta Workflows

### Okta Workflows

The steps below describe how to create an outgoing webhook in Apono that will send data on Apono access requests to Okta Workflows. Then, configure any workflow you'd like in [Okta Workflows](https://www.okta.com/platform/workflows/).

***

### Prerequisites

<table><thead><tr><th width="186">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>Permissions</strong></td><td>Super admin with access to Okta Workflows</td></tr><tr><td><strong>Configure your API endpoint settings</strong></td><td><p>Follow these steps to configure API endpoint settings:</p><ol><li>Create a flow in your Workflows Console and click <strong>Add event</strong>.</li><li>From the <strong>Pick an app to start your flow</strong> dialog, select <strong>API Endpoint</strong>.</li><li>In the <strong>API endpoint settings</strong> dialog, select <strong>Secure with OAuth 2.0</strong> as the security level.</li></ol></td></tr></tbody></table>

***

### Create the webhook

Follow these steps to configure a webhook:

1. On the [**Webhooks**](https://app.apono.io/webhooks) page, click **Add Webhook**. The **Add Webhook** page appears.
2. Click **Request Webhook**.
3. Enter a unique, alphanumeric, user-friendly **Request Webhook Name** for identifying this webhook.
4. Click the **Status** toggle to **Active**.
5. From the **Method** dropdown menu, select **POST**.
6. In the **URL** field, enter *https\://\<DOMAIN>.workflows.okta.com/api/flo/\<CLIENT\_TOKEN>*.\
   \
   Be sure to replace `<DOMAIN>` with your company domain and `<CLIENT_TOKEN>` with the `clientToken` generated in Okta Workflows.

{% hint style="warning" %}
The webhook URL **must adhere** to the following requirements:

* Uses the HTTPS protocol
* Does **not** specify any custom ports
  {% endhint %}

7. In the **Body Template** field, construct a JSON body for the webhook payload.

{% code overflow="wrap" %}

```json
{
    "fields":{
        "event type": "{{event_type}}",
        "event time": "{{event_time}}",
        "requestor email": "{{data.requester.email}}",
        "integration name": "{{data.access_groups.[0].[integration].name}}",
        "resource type": "{{data.access_groups.[0].[resource_types].[0].name}}",
        "access units": "{{data.access_groups.[0].access_units.[0].resource.name}}"
    }
}
```

{% endcode %}

{% hint style="success" %}
Click **View event's payload schema** to reveal the payload schema and available data fields. You can also refer to the [Webhook Payload Schema Reference](https://docs.apono.io/docs/webhook-integrations/webhook-payload-references/webhook-payload-schema-reference) to read the descriptions of each data field.
{% endhint %}

8. (Optional) Under **Headers**, use the following **Key** and **Value** value to set the header. You can set the `clientToken` as a header value instead of passing it in the URL in step **6**.\
   \
   Be sure to replace the `<CLIENT_TOKEN>` placeholder.

| Key                  | Value              |
| -------------------- | ------------------ |
| *x-api-client-token* | *\<CLIENT\_TOKEN>* |

9. From the **Triggers** dropdown menu, select one or more of the following event triggers, which correspond to Apono access request statuses:
   * **RequestCreated**
   * **RequestApproved**
   * **RequestExpired**
   * **RequestFailed**
   * **RequestGranted**
   * **RequestRejected**
10. Under **Filters**, define one or several filter from the listed dropdown menus.

{% hint style="info" %}
Filters empower admins to control the data transmitted via webhooks, minimizing the amount of data third-party tools receive and reducing unnecessary clutter.

**Examples**:

* Send only production requests to your admins' Slack channel.
* Trigger Okta workflows for events from specific integrations or resource types.
* Open a ticket in Jira or ServiceNow for manually approved requests.
  {% endhint %}

11. (Optional) In the **Timeout in seconds** field, enter the duration in seconds to wait before marking the request as failed.
12. (Optional) Define **Response Validators** to verify that the response from the webhook meets specified criteria:
    1. Click **+ Add**. A row of settings appears.
    2. Starting with *$.data.*, enter the **Json Path** of the JSON parameter.
    3. In the **Expected Values** field, enter a value and press the Enter key on your keyboard.
    4. Repeat step **c** to add several expected values.
    5. Repeat steps **a-d** to add multiple response validators.
13. Click **Test** to generate a test event to trigger your webhook. A **Test successful** or **Test failed** response status will appear at the bottom of the page. A successful test will send mock data to the target system.

{% hint style="success" %}
For more information about the test, click **View Invocation Data**. A panel opens revealing the request, response, and other relevant details.

Should your test fail, view these tips to [troubleshoot your webhook](https://docs.apono.io/docs/webhook-integrations/troubleshoot-a-webhook).
{% endhint %}

14. Click **Save Webhook**.

The new webhook appears in the **Webhooks** table. Active webhooks are preceded by a green dot. Inactive webhooks are preceded by a white dot.

Apono access request logs will be sent to Okta Workflows based on the triggers you have selected.

***

## Results

Your webhook should now start sending events payloads to the workflow once triggered.

![](https://files.readme.io/841ab4d-image.png)

![](https://files.readme.io/46c7350-image.png)
