FIfirefly-iii
webhooks

Store a new webhook

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.

post/v1/webhooks

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/webhooks
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

activeboolean

Boolean to indicate if the webhook is active

titlestring string required

A title for the webhook for easy recognition.

trigger'STORE_TRANSACTION' | 'UPDATE_TRANSACTION' | 'DESTROY_TRANSACTION' string required

The trigger for the webhook.

response'TRANSACTIONS' | 'ACCOUNTS' | 'NONE' string required

Indicator for what Firefly III will deliver to the webhook URL.

delivery'JSON' string required

Format of the delivered response.

urlstring string required

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

Example request

{
  "title": "Update magic mirror on new transaction",
  "trigger": "DESTROY_TRANSACTION",
  "response": "RESPONSE_TRANSACTIONS",
  "delivery": "JSON",
  "url": "https://example.com"
}

Response

New webhook stored, result in response.

Example response

{
  "data": {
    "type": "webhooks",
    "id": "2",
    "attributes": {
      "created_at": "2025-08-01T00:00:00+00:00",
      "updated_at": "2025-08-01T00:00:00+00:00",
      "title": "Update magic mirror on new transaction",
      "secret": "iMLZLtLx2JHWhK9Dtyuoqyir",
      "trigger": "DESTROY_TRANSACTION",
      "response": "RESPONSE_TRANSACTIONS",
      "delivery": "JSON",
      "url": "https://example.com"
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.