Models

WebhookRead

object

typestringrequired

Immutable value

Example

webhooks

idstringrequired

Example

attributesWebhookPropertiesrequired

Show child attributes

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

linksObjectLinkrequired

Show child attributes

0object

Show child attributes

relstring

Example

self

uristring

Example

/OBJECTS/1

selfstring<uri>

Example

https://demo.firefly-iii.org/api/v1/OBJECTS/1

Example

{
  "type": "webhooks",
  "id": "2",
  "attributes": {
    "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"
  },
  "links": {
    "0": {
      "rel": "self",
      "uri": "/OBJECTS/1"
    },
    "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
  }
}