Log Streaming

Operations about log streaming destinations

List streamable event types

get

/settings/log-streaming/event-types

List the event types that can be streamed to a log streaming destination. Requires the eventBusDestination:list scope and the Log Streaming feature to be licensed.

Authorizations

X-N8N-API-KEYstringRequired

Responses

200

Operation successful.

application/json

datastring[]Required

Event names that can be streamed to a destination.

Example: ["n8n.workflow.started","n8n.workflow.success","n8n.workflow.failed"]

401

Unauthorized

403

Forbidden

get/settings/log-streaming/event-types

GET /api/v1/settings/log-streaming/event-types HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    "n8n.workflow.started",
    "n8n.workflow.success",
    "n8n.workflow.failed"
  ]
}

List log streaming destinations

get

/settings/log-streaming/destinations

List the configured log streaming destinations. Requires the eventBusDestination:list scope and the Log Streaming feature to be licensed.

Authorizations

X-N8N-API-KEYstringRequired

Responses

200

Operation successful.

application/json

dataone of[]Required

The configured log streaming destinations.

or

or

401

Unauthorized

403

Forbidden

get/settings/log-streaming/destinations

GET /api/v1/settings/log-streaming/destinations HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "88be6560-bfb4-455c-8aa1-06971e9e5522",
      "label": "My destination",
      "enabled": true,
      "subscribedEvents": [
        "n8n.workflow",
        "n8n.audit"
      ],
      "anonymizeAuditMessages": false,
      "circuitBreaker": {
        "maxFailures": 1,
        "failureWindow": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "type": "webhook",
      "url": "https://example.com/n8n-events",
      "method": "POST",
      "sendHeaders": false,
      "specifyHeaders": "keypair",
      "headerParameters": {
        "parameters": [
          {
            "name": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "jsonHeaders": "text",
      "sendQuery": false,
      "specifyQuery": "text",
      "queryParameters": {
        "parameters": [
          {
            "name": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "jsonQuery": "text",
      "options": {
        "timeout": 1,
        "allowUnauthorizedCerts": true,
        "queryParameterArrays": "indices",
        "redirect": {
          "redirect": {
            "followRedirects": true,
            "maxRedirects": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "proxy": {
          "proxy": {
            "protocol": "https",
            "host": "text",
            "port": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "socket": {
          "keepAlive": true,
          "maxSockets": 1,
          "maxFreeSockets": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Create a log streaming destination

post

/settings/log-streaming/destinations

Create a log streaming destination. The destination takes effect exactly as it would from the UI, using the same validation. Requires the eventBusDestination:create scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the write is rejected with 409 and nothing is created; reads still return the current values.

Authorizations

X-N8N-API-KEYstringRequired

Body

A log streaming destination. The type field selects the variant and its type-specific fields: webhook, syslog, or sentry.

or

or

Responses

200

Operation successful.

application/json

A log streaming destination. The type field selects the variant and its type-specific fields: webhook, syslog, or sentry.

or

or

400

The request is invalid or provides malformed data.

401

Unauthorized

403

Forbidden

409

Conflict

post/settings/log-streaming/destinations

POST /api/v1/settings/log-streaming/destinations HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1190

{
  "label": "My destination",
  "enabled": true,
  "subscribedEvents": [
    "n8n.workflow",
    "n8n.audit"
  ],
  "anonymizeAuditMessages": false,
  "circuitBreaker": {
    "maxFailures": 1,
    "failureWindow": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "webhook",
  "url": "https://example.com/n8n-events",
  "method": "POST",
  "sendHeaders": false,
  "specifyHeaders": "keypair",
  "headerParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonHeaders": "text",
  "sendQuery": false,
  "specifyQuery": "text",
  "queryParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonQuery": "text",
  "options": {
    "timeout": 1,
    "allowUnauthorizedCerts": true,
    "queryParameterArrays": "indices",
    "redirect": {
      "redirect": {
        "followRedirects": true,
        "maxRedirects": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "proxy": {
      "proxy": {
        "protocol": "https",
        "host": "text",
        "port": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "socket": {
      "keepAlive": true,
      "maxSockets": 1,
      "maxFreeSockets": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "id": "88be6560-bfb4-455c-8aa1-06971e9e5522",
  "label": "My destination",
  "enabled": true,
  "subscribedEvents": [
    "n8n.workflow",
    "n8n.audit"
  ],
  "anonymizeAuditMessages": false,
  "circuitBreaker": {
    "maxFailures": 1,
    "failureWindow": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "webhook",
  "url": "https://example.com/n8n-events",
  "method": "POST",
  "sendHeaders": false,
  "specifyHeaders": "keypair",
  "headerParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonHeaders": "text",
  "sendQuery": false,
  "specifyQuery": "text",
  "queryParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonQuery": "text",
  "options": {
    "timeout": 1,
    "allowUnauthorizedCerts": true,
    "queryParameterArrays": "indices",
    "redirect": {
      "redirect": {
        "followRedirects": true,
        "maxRedirects": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "proxy": {
      "proxy": {
        "protocol": "https",
        "host": "text",
        "port": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "socket": {
      "keepAlive": true,
      "maxSockets": 1,
      "maxFreeSockets": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Send a test message to a log streaming destination

post

/settings/log-streaming/destinations/{id}/test

Send a test message to the destination to verify it is reachable and configured correctly. Requires the eventBusDestination:test scope and the Log Streaming feature to be licensed.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The id of the log streaming destination.

Responses

200

Operation successful.

application/json

successbooleanRequired

Whether the test message was delivered to the destination successfully.

Example: true

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/settings/log-streaming/destinations/{id}/test

POST /api/v1/settings/log-streaming/destinations/{id}/test HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Retrieve a log streaming destination

get

/settings/log-streaming/destinations/{id}

Retrieve a single log streaming destination by id. Requires the eventBusDestination:read scope and the Log Streaming feature to be licensed.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The id of the log streaming destination.

Responses

200

Operation successful.

application/json

A log streaming destination. The type field selects the variant and its type-specific fields: webhook, syslog, or sentry.

or

or

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/settings/log-streaming/destinations/{id}

GET /api/v1/settings/log-streaming/destinations/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "88be6560-bfb4-455c-8aa1-06971e9e5522",
  "label": "My destination",
  "enabled": true,
  "subscribedEvents": [
    "n8n.workflow",
    "n8n.audit"
  ],
  "anonymizeAuditMessages": false,
  "circuitBreaker": {
    "maxFailures": 1,
    "failureWindow": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "webhook",
  "url": "https://example.com/n8n-events",
  "method": "POST",
  "sendHeaders": false,
  "specifyHeaders": "keypair",
  "headerParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonHeaders": "text",
  "sendQuery": false,
  "specifyQuery": "text",
  "queryParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonQuery": "text",
  "options": {
    "timeout": 1,
    "allowUnauthorizedCerts": true,
    "queryParameterArrays": "indices",
    "redirect": {
      "redirect": {
        "followRedirects": true,
        "maxRedirects": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "proxy": {
      "proxy": {
        "protocol": "https",
        "host": "text",
        "port": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "socket": {
      "keepAlive": true,
      "maxSockets": 1,
      "maxFreeSockets": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Update a log streaming destination

put

/settings/log-streaming/destinations/{id}

Replace an existing log streaming destination. The update takes effect exactly as it would from the UI, using the same validation. Requires the eventBusDestination:update scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the write is rejected with 409 and nothing is changed; reads still return the current values.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The id of the log streaming destination.

Body

A log streaming destination. The type field selects the variant and its type-specific fields: webhook, syslog, or sentry.

or

or

Responses

200

Operation successful.

application/json

A log streaming destination. The type field selects the variant and its type-specific fields: webhook, syslog, or sentry.

or

or

400

The request is invalid or provides malformed data.

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

409

Conflict

put/settings/log-streaming/destinations/{id}

PUT /api/v1/settings/log-streaming/destinations/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1190

{
  "label": "My destination",
  "enabled": true,
  "subscribedEvents": [
    "n8n.workflow",
    "n8n.audit"
  ],
  "anonymizeAuditMessages": false,
  "circuitBreaker": {
    "maxFailures": 1,
    "failureWindow": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "webhook",
  "url": "https://example.com/n8n-events",
  "method": "POST",
  "sendHeaders": false,
  "specifyHeaders": "keypair",
  "headerParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonHeaders": "text",
  "sendQuery": false,
  "specifyQuery": "text",
  "queryParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonQuery": "text",
  "options": {
    "timeout": 1,
    "allowUnauthorizedCerts": true,
    "queryParameterArrays": "indices",
    "redirect": {
      "redirect": {
        "followRedirects": true,
        "maxRedirects": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "proxy": {
      "proxy": {
        "protocol": "https",
        "host": "text",
        "port": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "socket": {
      "keepAlive": true,
      "maxSockets": 1,
      "maxFreeSockets": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "id": "88be6560-bfb4-455c-8aa1-06971e9e5522",
  "label": "My destination",
  "enabled": true,
  "subscribedEvents": [
    "n8n.workflow",
    "n8n.audit"
  ],
  "anonymizeAuditMessages": false,
  "circuitBreaker": {
    "maxFailures": 1,
    "failureWindow": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "webhook",
  "url": "https://example.com/n8n-events",
  "method": "POST",
  "sendHeaders": false,
  "specifyHeaders": "keypair",
  "headerParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonHeaders": "text",
  "sendQuery": false,
  "specifyQuery": "text",
  "queryParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonQuery": "text",
  "options": {
    "timeout": 1,
    "allowUnauthorizedCerts": true,
    "queryParameterArrays": "indices",
    "redirect": {
      "redirect": {
        "followRedirects": true,
        "maxRedirects": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "proxy": {
      "proxy": {
        "protocol": "https",
        "host": "text",
        "port": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "socket": {
      "keepAlive": true,
      "maxSockets": 1,
      "maxFreeSockets": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete a log streaming destination

delete

/settings/log-streaming/destinations/{id}

Remove a log streaming destination. Requires the eventBusDestination:delete scope and the Log Streaming feature to be licensed. When destinations are managed via environment variables, the delete is rejected with 409 and nothing is removed; reads still return the current values.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The id of the log streaming destination.

Responses

200

Operation successful.

application/json

A log streaming destination. The type field selects the variant and its type-specific fields: webhook, syslog, or sentry.

or

or

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

409

Conflict

delete/settings/log-streaming/destinations/{id}

DELETE /api/v1/settings/log-streaming/destinations/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "88be6560-bfb4-455c-8aa1-06971e9e5522",
  "label": "My destination",
  "enabled": true,
  "subscribedEvents": [
    "n8n.workflow",
    "n8n.audit"
  ],
  "anonymizeAuditMessages": false,
  "circuitBreaker": {
    "maxFailures": 1,
    "failureWindow": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "type": "webhook",
  "url": "https://example.com/n8n-events",
  "method": "POST",
  "sendHeaders": false,
  "specifyHeaders": "keypair",
  "headerParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonHeaders": "text",
  "sendQuery": false,
  "specifyQuery": "text",
  "queryParameters": {
    "parameters": [
      {
        "name": "Authorization",
        "value": "Bearer <token>"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "jsonQuery": "text",
  "options": {
    "timeout": 1,
    "allowUnauthorizedCerts": true,
    "queryParameterArrays": "indices",
    "redirect": {
      "redirect": {
        "followRedirects": true,
        "maxRedirects": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "proxy": {
      "proxy": {
        "protocol": "https",
        "host": "text",
        "port": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "socket": {
      "keepAlive": true,
      "maxSockets": 1,
      "maxFreeSockets": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}