FIfirefly-iii
webhooks

Update existing webhook.

Update an existing webhook's information. If you wish to reset the secret, submit any value as the "secret". Firefly III will take this as a hint and reset the secret of the webhook.

put/v1/webhooks/{id}

Request

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

Path parameters

idstring required
Example:123

The webhook ID.

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

A title for the webhook for easy recognition.

secretstring 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.

triggersWebhookTrigger[]
responsesWebhookResponse[]
deliveriesWebhookDelivery[]
urlstring string

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

Example request

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

Response

Updated webhook stored, result in response

Example response

{
  "data": {
    "type": "webhooks",
    "id": "2",
    "attributes": {
      "created_at": "2026-02-01T00:00:00+00:00",
      "updated_at": "2026-02-01T00:00:00+00:00",
      "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"
    }
  }
}

Changes

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