Webhooks

Store a new webhook

POST

https://firefly.example.com/api/v1/webhooks

Creates a new webhook. The data required can be submitted as a JSON body or as a list of parameters. The webhook will be given a random secret.

Store a new webhook

curl -X POST 'https://firefly.example.com/api/v1/webhooks' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}'

const body = `{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}`;

const response = await fetch('https://firefly.example.com/api/v1/webhooks', {
  method: 'POST',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}'''

response = requests.post(
    'https://firefly.example.com/api/v1/webhooks',
    data=body.encode('utf-8'),
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}

{
  "active": false,
  "title": "Update magic mirror on new transaction",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}

{
  "data": {
    "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"
    }
  }
}

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "string"
    ],
    "force": [
      "string"
    ],
    "blocked": [
      "string"
    ],
    "field": [
      "string"
    ],
    "role": [
      "string"
    ],
    "blocked_code": [
      "string"
    ],
    "name": [
      "string"
    ],
    "type": [
      "string"
    ],
    "iban": [
      "string"
    ],
    "start": [
      "string"
    ],
    "end": [
      "string"
    ],
    "date": [
      "string"
    ]
  }
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Body

JSON array or key=value pairs with the necessary webhook information. See the model for the exact specifications.

application/json,application/x-www-form-urlencodedWebhookStore

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

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

Parameters

X-Trace-Idstring<uuid>header

Unique identifier associated with this request.

Response

200OKWebhookSingle

New webhook stored, result in response.

Response fields application/vnd.api+json

dataWebhookReadrequired

Show child attributes

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

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

422Unprocessable EntityValidationErrorResponse

Validation error. The body will have the exact details.

Response fields application/json

messagestring

Example

The given data was invalid.

errorsobject

Show child attributes

emailArray<string>

forceArray<string>

blockedArray<string>

fieldArray<string>

roleArray<string>

blocked_codeArray<string>

nameArray<string>

typeArray<string>

ibanArray<string>

startArray<string>

endArray<string>

dateArray<string>

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.