banks2ff/firefly-iii-api/docs/Webhook.md
Jacob Kiers f0b8df90b9 Initial commit
This is definitely not functional yet.

Signed-off-by: Jacob Kiers <code@kiers.eu>
2024-10-04 20:31:39 +02:00

20 lines
1.2 KiB
Markdown

# Webhook
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | Option<**String**> | | [optional][readonly]
**updated_at** | Option<**String**> | | [optional][readonly]
**active** | Option<**bool**> | Boolean to indicate if the webhook is active | [optional]
**title** | **String** | A title for the webhook for easy recognition. |
**secret** | Option<**String**> | A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. | [optional][readonly]
**trigger** | [**models::WebhookTrigger**](WebhookTrigger.md) | |
**response** | [**models::WebhookResponse**](WebhookResponse.md) | |
**delivery** | [**models::WebhookDelivery**](WebhookDelivery.md) | |
**url** | **String** | The URL of the webhook. Has to start with `https`. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)