Models

WebhookProperties

object

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

activeboolean

Boolean to indicate if the webhook is active

Example

false

titlestringrequired

A title for the webhook for easy recognition.

Example

Update magic mirror on new transaction

secretstringread only

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.

Example

iMLZLtLx2JHWhK9Dtyuoqyir

triggersArray<WebhookTrigger>ANYSTORE_TRANSACTIONUPDATE_TRANSACTIONDESTROY_TRANSACTIONSTORE_BUDGETUPDATE_BUDGETDESTROY_BUDGETSTORE_UPDATE_BUDGET_LIMIT

Example

[
  "STORE_TRANSACTION",
  "UPDATE_TRANSACTION"
]

responsesArray<WebhookResponse>TRANSACTIONSACCOUNTSBUDGETRELEVANTNONE

Example

[
  "TRANSACTIONS"
]

deliveriesArray<WebhookDelivery>JSON

Example

[
  "JSON"
]

urlstringrequired

The URL of the webhook. Has to start with https.

Example

https://example.com

Example

{
  "created_at": "2026-10-01T00:00:00+00:00",
  "updated_at": "2026-10-01T00:00:00+00:00",
  "active": false,
  "title": "Update magic mirror on new transaction",
  "secret": "iMLZLtLx2JHWhK9Dtyuoqyir",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}