Skip to content

Commit

Permalink
Merge pull request #157 from CybercentreCanada/ppa_webhooks
Browse files Browse the repository at this point in the history
Provide an example of using PPAs with webhook configurations
  • Loading branch information
cccs-rs authored Feb 25, 2025
2 parents b2eb0e3 + f8b7dd6 commit 61a1151
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/administration/submission_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Depending on the context where the submission is being tested for an action diff

## Action configuration

!!! tip "Actions are disabled by default and must be enabled using `enabled: true` setting"

### Alert

There are no sub-configuration fields of the `raise_alert` field, it is either true or false.
Expand All @@ -39,6 +41,20 @@ The `webhook` action will call a webhook url with a body holding a json object w

The `webhook` field must be a [Webhook](../../odm/models/actions/#webhook) object.

!!! example "Here is an example using [Webhook Tester](https://webhook-test.com/)"
This webhook is only triggered on submission completion and only sends if the submission belongs to `user`.
```yaml
user_webhook:
enabled: true
run_on_completed: true
filter: 'params.submitter:user'
webhook:
uri: https://webhook-test.com/<UUID>
method: POST
username: xyz
password: xyz
```

## Default actions

By default Assemblyline comes with two actions defined:
Expand Down

0 comments on commit 61a1151

Please sign in to comment.