Webhooks events and payloads

Process execution webhooks are used during the execution of processes you run on spektr's platform.

Read more about webhooks in spektr here.

🚧

WIP

These events are work in progress and their definition might slightly change in the final version.

Webhook	Description	Status
PROCESS_RUN_START	Event created when a process starts running	Available
PROCESS_RUN_END	Event created when a process finishes running	Available
STEP_INIT	Event created when a form step is called in a process execution	WIP
STEP_SUBMIT	Event created when a form step is submitted by the user	WIP
SERVICE_RUN	Event created when a service response is received	Available
ALERT_CREATED	Event created when an alert is created	WIP
ALERT_RESOLVED	Event created when an alert is resolved	Available
CUSTOMER_TAG_ADDED	Event created when a tag is added to a customer by a process or a user	Available
CUSTOMER_TAG_REMOVED	Event created when a tag is removed from a customer by a user	Available
CUSTOMER_STATUS_CHANGED	Event created when the status of a customer changes through a status node or manually by a user	Available

PROCESS_RUN_START

JSON

{
  "id": "<event-id>",
  "spektrId": "<id end-user related to this event>",
  "type": "process_run_start",
  "delivered": true,
  "createdAt": 1672531199000,
  "reference": "optional-reference",
  "data": {
    "processType": "risk",
    "processName": "Risk Assessment",
    "processId": "12345",
    "contextId": "67890"
  }
}

Name	Type	Description
id	string	Event ID.
spektrId	string	ID of the end-user related to this event.
type	string	Type of event, e.g., process_run_start.
delivered	boolean \	null
createdAt	number	Epoch timestamp when the event was created.
processType	string	Type of process, e.g., 'risk', 'monitoring', 'onboarding', etc.
processName	string	Name of the process.
processId	string	ID of the process.
contextId	string	ID of the run.
reference	string	Optional value passed to the onboarding process through a query param.

PROCESS_RUN_END

JSON

{
  "id": "<event-id>",
  "spektrId": "<id end-user related to this event>",
  "type": "<event-type>",
  "delivered": null,
  "process_name": "<process-name>",
  "process_output": "<process-output>",
  "files": {
    "clientFiles": ["<file1>", "<file2>"]
  },
  "fields": [
    {
      "key": "<field-key>",
      "label": "<field-label>",
      "helptext": "<field-helptext>",
      "placeholder": "<field-placeholder>",
      "internalId": "<field-internal-id>",
    }
  ],
  "data": {},
  "createdAt": 1672531199000
}

Name	Type	Description
id	string	Event identifier.
spektrId	string	ID of the end-user related to this event.
type	string	Event type, e.g. process_run_end
delivered	boolean \	null
process_name	string	Name of the process.
process_output	string	Output of the process.
files.clientFiles	Array of strings	Contains urls for end-user files. Valid for 24 hour.
fields	Array of Fields	List of fields.
field.key	string \	null
field.label	string \	null
field.helptext	string \	null
field.placeholder	string \	null
field.internalId	string \	null
children	Array of Fields	Optional child fields. Max 1 recursive depth.
data	object	key-value entries from end-user or external services. 'key' corresponds to field.key when entry was submitted by end-user.
createdAt	number	Epoch timestamp when the event was created.

STEP_SUBMIT (WIP)

Documentation will be made available when this event type is publicly available.

SERVICE_RUN

JSON

{
  "id": "<event-id>",
  "spektrId": "<id end-user related to this event>",
  "type": "service_run",
  "delivered": true,
  "createdAt": 1672531199000,
  "data": {
    "vendorType": "service type",
    "contextId":"<process run id",
    "processId":"<process id>",
    "processName": "process name",
    "processType": "process type",
    "reference": "optional-reference"
  }
}

Name	Type	Description
id	string	Event ID.
spektrId	string	ID of the end-user related to this event.
type	string	Type of event, e.g., "service_run".
delivered	boolean	True if the event is already delivered via webhook, falsy otherwise.
createdAt	number	Epoch timestamp when the event was created.
data.vendorType	string	Type of the vendor.
data.contextId	string	ID of the process run.
data.processId	string	ID of the process.
data.processName	string	Name of the process.
data.processType	string	Type of process, e.g., 'risk', 'monitoring', 'onboarding', etc.
data.reference	string \	null

ALERT_CREATED (WIP)

Documentation will be made available when this event type is publicly available.

ALERT_RESOLVED

JSON

{
  "id": "<event-id>",
  "spektrId": "<id end-user related to this event>",
  "type": "alert_resolved",
  "delivered": true,
  "createdAt": 1672531199000,
  "data": {
		"contextId":"<process-run-id",
    "processId":"<process-id>",
		"userId":"<user-id that resolved alert>",
		"alertId":"<alert-id>",
		"alertName": "<alert name>
  }
}

Name	Type	Description
id	string	Event ID.
spektrId	string	ID of the end-user related to this event.
type	string	Type of event, e.g., "alert_resolved".
delivered	boolean	True if the event is already delivered via webhook, falsy otherwise.
createdAt	number	Epoch timestamp when the event was created.
data.contextId	string	ID of the process run.
data.processId	string	Process ID.
data.userId	string	ID of the user who resolved the alert.
data.alertId	string	Alert ID.
data.alertName	string	Name of the alert.

CUSTOMERTAG<ADD|REMOVE>

JSON

{
  "id": "<event-id>",
  "spektrId": "<id end-user to/from which the tag was added/removed>",
  "type": "customer_tag_add" | "customer_tag_remove",
  "delivered": true,
  "createdAt": 1672531199000,
  "data": {
    "tagId": "<tag-id>",
    "action": "add" | "remove",
		"userId":"<user-id that added/removed the tag>",
		"processId":"<process-id that added/removed>"
  }

Name	Type	Description
id	string	Event ID.
spektrId	string	ID of the end-user to which the tag was added.
type	string	Type of event, e.g., "customer_tag_add" or "customer_tag_remove"
delivered	boolean	True if the event is already delivered via webhook, false otherwise.
createdAt	number	Epoch timestamp when the event was created.
data.tagId	string	Tag ID.
data.action	string	Action performed, i.e., 'add' or 'remove'
data.userId	string \	null
data.processId	string \	null

CUSTOMER_STATUS_CHANGED

JSON

{
  "id": "<event-id>",
  "spektrId": "<id end-user to which the tag was added>",
  "type": "customer_tag_add",
  "delivered": true,
  "createdAt": 1672531199000,
  "data": {
    "oldStatus": "<old status>",
		"newStatus":"<new status>",
    "customerName": "name of the end-user (individual or corporation)",
		"userId":"<user-id that changed the status if changed by user>",
    "processId": "<process-id that changed the status if changed by a process>",
		"processName": "<process name that changed the status if changed by a process>"
  }
}

Name	Type	Description
id	string	Event ID.
spektrId	string	ID of the end-user to which the tag was added.
type	string	Type of event, e.g., "customer_tag_add".
delivered	boolean	True if the event is already delivered via webhook, falsy otherwise.
createdAt	number	Epoch timestamp when the event was created.
data.oldStatus	string	Old status before the change.
data.newStatus	string	New status after the change.
data.customerName	string	Name of the end-user (individual or corporation).
data.userId	string \	null
data.processId	string \	null
data.processName	string \	null