curl --request GET \ --url 'https://app.output.rocks/api/webhooks?page=1&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BgroupIdentifier%5D=asc&order%5Bpriority%5D=asc&order%5Btype%5D=asc&order%5Bemail%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \ --header 'X-AUTH-TOKEN: <api-key>'

[ { "id": 12345, "identifier": "my-webhook", "email": false, "type": "sftp-document", "priority": 1, "data": { "host": "sftp.example.com", "user": "sftp-user", "password": "sftp-password", "directory": "sftp-directory/sub-directory", "port": 22 }, "configuration": [ "string" ], "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "client": {}, "subClient": {}, "active": true, "activeFrom": "2024-01-01", "versionGroup": "123e4567-e89b-12d3-a456-426614174000", "versionNumber": 1, "supersededAt": "2024-08-23T00:00:00+00:00", "changeSummaryDe": "string", "changeSummaryEn": "string", "summaryStatus": "pending", "groupIdentifier": "my_group", "groupCondition": "data['contract']['balance'] > 0", "subClientDefault": false, "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" } ]

Webhook

Retrieves a list of webhooks

GET/api/webhooks

Retrieves a list of webhooks

curl --request GET \
  --url 'https://app.output.rocks/api/webhooks?page=1&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BgroupIdentifier%5D=asc&order%5Bpriority%5D=asc&order%5Btype%5D=asc&order%5Bemail%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "identifier": "my-webhook",
    "email": false,
    "type": "sftp-document",
    "priority": 1,
    "data": {
      "host": "sftp.example.com",
      "user": "sftp-user",
      "password": "sftp-password",
      "directory": "sftp-directory/sub-directory",
      "port": 22
    },
    "configuration": [
      "string"
    ],
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "client": {},
    "subClient": {},
    "active": true,
    "activeFrom": "2024-01-01",
    "versionGroup": "123e4567-e89b-12d3-a456-426614174000",
    "versionNumber": 1,
    "supersededAt": "2024-08-23T00:00:00+00:00",
    "changeSummaryDe": "string",
    "changeSummaryEn": "string",
    "summaryStatus": "pending",
    "groupIdentifier": "my_group",
    "groupCondition": "data['contract']['balance'] > 0",
    "subClientDefault": false,
    "subClientId": 3,
    "subClientDescription": "Branch Office A",
    "subClientColor": "#083E5D"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[identifier]

stringdefault:asc

No description provided.

order[groupIdentifier]

stringdefault:asc

No description provided.

order[priority]

stringdefault:asc

No description provided.

order[type]

stringdefault:asc

No description provided.

order[email]

stringdefault:asc

No description provided.

order[activeFrom]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

identifier

string

No description provided.

groupIdentifier

string

No description provided.

groupIdentifier[]

string[]

No description provided.

type

string

No description provided.

type[]

string[]

No description provided.

boolean

No description provided.

active

boolean

No description provided.

string

Global webhook search across id, identifier, group identifier, priority, type, status, email flag, and dates.

activeFrom[before]

string

No description provided.

activeFrom[strictly_before]

string

No description provided.

activeFrom[after]

string

No description provided.

activeFrom[strictly_after]

string

No description provided.

Response

200application/json

Webhook collection

integer

Webhook ID generated by Output.Rocks.

Example: 12345

identifier

stringrequired

Customer Identifier, used for webhook selection in rendering process

Example: "my-webhook"

boolean

Available options: truefalse

Example: false

type

enum<string>

Webhook type

Available options: chargecloud-documentcustom-oauth2-documentcustom-oauth2-emailprerender-api-documentprerender-api-emailprerender-custom-oauth2-documentprerender-custom-oauth2-emailprerender-custom-oauth2-requestprerender-powercloud-zugferd-mapping-documentprerender-kvasy-zugferd-mapping-documentbinect-documentbinect-emailepostbusiness-documentepostbusiness-emailsftp-documentsftp-emails3-archive-documents3-archive-email

Example: "sftp-document"

priority

integer

Webhook execution priority

Example: 1

data

object

Webhook configuration data.<br><b>IMPORTANT:</b> data structure depends on webhook type

Example: {"host":"sftp.example.com","user":"sftp-user","password":"sftp-password","directory":"sftp-directory/sub-directory","port":22}

configuration

string | null[]

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

client

object

subClient

object

active

boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom

string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

versionGroup

string<uuid>

Immutable lineage key shared by all versions of this configuration entry.

versionNumber

integer

Monotonic version counter within the version group. Display/audit only, not part of resolution.

Example: 1

supersededAt

string<date-time>

Moment from which this version is superseded by a newer version of the same version group. Null while the version is (or is scheduled to become) the current one.

changeSummaryDe

string

AI generated German summary of the changes introduced by this version.

changeSummaryEn

string

AI generated English summary of the changes introduced by this version.

summaryStatus

enum<string>

Generation status of the AI change summary.

Available options: pendingdonefailed

groupIdentifier

string

Optional group identifier to be used with group conditions

Example: "my_group"

groupCondition

string

Group condition.

Example: "data['contract']['balance'] > 0"

subClientDefault

boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor

string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"