OS4X Core event web API calls - Revision history

Admin: /* end receive web API call */

2026-02-25T10:54:54Z

end receive web API call

Admin: /* end receive web API call */

2026-02-25T10:26:06Z

end receive web API call

Admin: /* additional HTTP header variables */

2026-02-20T16:01:05Z

additional HTTP header variables

Admin at 16:00, 20 February 2026

2026-02-20T16:00:52Z

Admin at 12:47, 19 February 2026

2026-02-19T12:47:28Z

Admin: /* Send queue cleanup event */

2026-02-19T12:44:04Z

Send queue cleanup event

Admin: /* OS4X Enterprise job abort script */

2026-02-19T12:31:36Z

OS4X Enterprise job abort script

Admin: /* System log event */

2026-02-19T12:19:15Z

System log event

Admin: /* OS4X Enterprise user created event */

2026-02-19T12:17:39Z

OS4X Enterprise user created event

Admin: /* Event failure script */

2026-02-19T12:17:11Z

Event failure script

@@ Line 113: / Line 113: @@
 *<code>event_parameter</code>: freely configurable partner event parameter
 *<code>record_size</code>: maximum record size ("<code>0</code>" if transferred in binary or text mode)
 *<code>as2_subject</code>: if the transmission was in AS2 protocol, this parameter carries the AS2 subject

@@ Line 113: / Line 113: @@
 *<code>event_parameter</code>: freely configurable partner event parameter
 *<code>record_size</code>: maximum record size ("<code>0</code>" if transferred in binary or text mode)
 == start send web API call ==

@@ Line 14: / Line 14: @@
 == additional HTTP header variables ==
 [[File:Bildschirmfoto 2026-02-20 um 17.00.03.png]]
 [[File:Bildschirmfoto 2026-02-20 um 16.59.05.png]]
 == start session web API call ==

@@ Line 12: / Line 12: @@
 *<code>OS4X_UPDATE</code>: OS4X update package
 *<code>OFTP_COMMUNICATION_SETUP</code>: OFTP2 PDX communication setup file
 == start session web API call ==

@@ Line 3: / Line 3: @@
 The events are configured via web interface. This configuration is stored in the database, which will be read by every binary on startup and on every configuration reload. Web request events must start with "<code>http://</code>" or "<code>https://</code>" in case-sensitive written mode.
-All events, except of the start receive event, run in the background and don't influence active OS4X transfers during their execution. The parameters of the web request will be provided as POST parameter.
+All events, except of the start receive event & send queue cleanup event, run in the background and don't influence active OS4X transfers during their execution. The parameters of the web request will be provided as POST parameter.
 The following virtual filenames are reserved and therefor no "normal" event API call will be run on these files (send, receive, xERP & block):

@@ Line 273: / Line 273: @@
 The XML itself is attached as multipart file attachement to the request. Since the event will be executed '''synchronously''', there is no need to clean up the temporary XML file: OS4X cleans it up automatically.
-== Send queue cleanup event ==
+== Send queue cleanup web API call ==
 If the send queue daemon is configured to delete successfully sent send queue entries with a configured age, this event can be triggered in order to handle the information that the entry is removed. This event is being executed synchronously and not in parallel, so keep in mind to make this event performant.
 Parameters:
-*1. partner shortname
+*<code>event</code>: <code>send_queue_cleanup</code>
-*2. virtual filename
+*<code>shortname</code>: partner shortname
-*3. real filename with absolute path
+*<code>virt_filename</code>: virtual filename
-*4. send queue entry comment
+*<code>real_filename</code>: real filename with absolute path
-*5. partner index
+*<code>comment</code>: send queue entry comment
-*6. referenced job ID
+*<code>comment2</code>: send queue entry comment #2
-*7. referenced file ID
+*<code>idx</code>: partner index
-*8. freely configurable partner event parameter
+*<code>ref_job</code>: referenced job ID
-*9. send queue entry comment #2
+*<code>ref_file</code>: referenced file ID
-*10. file datestamp
+*<code>file_datestamp</code>: OFTP2 file datestamp
-*11. file timestamp
+*<code>file_timestamp</code>: OFTP2 file timestamp
-*12. real filename with absolute path before OFTP2 security operation(s)
+*<code>event_parameter</code>: freely configurable partner event parameter

@@ Line 262: / Line 262: @@
 *<code>event_parameter</code>: freely configurable partner event parameter
-== OS4X Enterprise job abort script ==
+== OS4X Enterprise job abort web API call ==
 If [[OS4X_Core_configuration#is_OS4X_Enterprise_installed.3F|OS4X Enterprise is enabled]] in the configuration ('<code>Configuration</code>' -> '<code>OS4X Enterprise</code>' -> '<code>Is OS4X Enterprise installed</code>'), this input field is active for configuration, otherwise it will not be displayed. This event will be executed '''synchronously''' every time an OS4X job gets into a final aborted state (send jobs: 4; receive jobs: 9). It has the following parameters:
-#numeric job ID
+Parameters:
-#status ID (see above in order to distinguish incoming and outgoing job by its status value)
+*<code>event</code>: <code>enterprise_job_abort</code>
-#absolute path to the job's actual XML file, containing all information i.e. sender, recipient, files, command etc.
+*<code>job_id</code>: numeric job ID
-Since the script will be executed '''synchronously''', there is no need to clean up the temporary XML file: OS4X cleans it up automatically.
+The XML itself is attached as multipart file attachement to the request. Since the event will be executed '''synchronously''', there is no need to clean up the temporary XML file: OS4X cleans it up automatically.
 == Send queue cleanup event ==

← Older revision		Revision as of 12:19, 19 February 2026
Line 270:		Line 270:

	Since the script will be executed '''synchronously''', there is no need to clean up the temporary XML file: OS4X cleans it up automatically.		Since the script will be executed '''synchronously''', there is no need to clean up the temporary XML file: OS4X cleans it up automatically.
−
−	~~== System log event ==~~
−	~~This event is being executed for every system log entry added (configurable: only non-OK values are fired).~~
−
−	~~Parameters:~~
−	*1. numeric error code with the following meaning:
−	**0: everything OK
−	**-2: warning
−	**anything else: error
−	*2. The complete error message.

	== Send queue cleanup event ==		== Send queue cleanup event ==

← Older revision		Revision as of 12:17, 19 February 2026
Line 297:		Line 297:
	*11. file timestamp		*11. file timestamp
	*12. real filename with absolute path before OFTP2 security operation(s)		*12. real filename with absolute path before OFTP2 security operation(s)
−
−	~~== OS4X Enterprise user created event ==~~
−	~~If via administrative web interface a new user is created, this event will be fired:~~
−	*1. Person index: primary key of the recipient in the database table "<tableprefix>recipients"
−	*2. Surname of the new recipient
−	*3. Name of the new recipient
−	*4. Email address of the new recipient
−	*5. Username
−	*6. Auth.type (0: PAM, 1: internal, 2: SSO)
−	*7. User type ("internal" or "portal")
−	*8. Password
−	*9. Portal index: -1 or primary key of the portal used in the database table "<tableprefix>portals"