Skip to content

Commit

Permalink
better readable README
Browse files Browse the repository at this point in the history
  • Loading branch information
lfkdev committed Jun 26, 2024
1 parent 2c24ad0 commit aae36c6
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,19 +178,20 @@ webhook:

or leave it commented out to disable webhooks

**url** The webhook URL for your chosen platform.
**type** The type of webhook (slack, discord, or generic).
**timeout** The timeout for webhook requests in seconds (optional, default is 5 seconds).
* **url** The webhook URL for your chosen platform.
* **type** The type of webhook (slack, discord, or generic).
* **timeout** The timeout for webhook requests in seconds (optional, default is 5 seconds).

Only Slack and Discord are supported for now, you can also use `generic` which will send the base JSON payload:

```json
base_payload = {
"event_type": event_type,
"job_id": job_data['job_id'],
"playbook": job_data['playbook'],
"status": job_data['status'],
"timestamp": datetime.now().isoformat()
}
base_payload = {
"event_type": event_type,
"job_id": job_data['job_id'],
"playbook": job_data['playbook'],
"status": job_data['status'],
"timestamp": datetime.now().isoformat()
}
```

The following notifcations are sent:
Expand Down

0 comments on commit aae36c6

Please sign in to comment.