Webhooks

Get a single message from a webhook.

GET

https://firefly.example.com/api/v1/webhooks/{id}/messages/{messageId}

When a webhook is triggered it will store the actual content of the webhook in a webhook message. You can view and analyse a single one using this endpoint.

curl -X GET 'https://firefly.example.com/api/v1/webhooks/123/messages/1' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://firefly.example.com/api/v1/webhooks/123/messages/1', {
  method: 'GET',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://firefly.example.com/api/v1/webhooks/123/messages/1',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

{
  "data": {
    "type": "webhook_messages",
    "id": "2",
    "attributes": {
      "created_at": "2026-10-01T00:00:00+00:00",
      "updated_at": "2026-10-01T00:00:00+00:00",
      "sent": false,
      "errored": false,
      "webhook_id": "5",
      "uuid": "7a344c02-5b52-46b1-90e6-a437431dcf07",
      "message": "{some:message}"
    }
  }
}

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

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

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

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

Parameters

X-Trace-Idstring<uuid>header

Unique identifier associated with this request.

idstringrequiredpath

The webhook ID.

messageIdintegerrequiredpath

The webhook message ID.

Response

200OKWebhookMessageSingle

A single webhook message.

Response fields application/vnd.api+json

dataWebhookMessageReadrequired

Show child attributes

typestringrequired

Immutable value

Example

webhook_messages

idstringrequired

Example

attributesWebhookMessagerequired

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

sentboolean

If this message is sent yet.

Example

false

erroredboolean

If this message has errored out.

Example

false

webhook_idstring

The ID of the webhook this message belongs to.

Example

uuidstring

Long UUID string for identification of this webhook message.

Example

7a344c02-5b52-46b1-90e6-a437431dcf07

messagestring | null

The actual message that is sent or will be sent as JSON string.

Example

{some:message}

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

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.