POST
/
unified
/
screening
/
results
/
webhook
curl --request POST \
  --url https://api.stackone.com/unified/screening/results/webhook \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "event": "screening.result.completed",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "order_id": "12345",
    "score": {
      "label": "Overall Risk",
      "value": "75",
      "min": "0",
      "max": "100"
    },
    "start_date": "2023-01-01T00:00:00Z",
    "submission_date": "2023-01-02T00:00:00Z",
    "summary": "Background check completed successfully",
    "status": "completed",
    "result_url": "https://example.com/results/12345"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}'
{
  "event": "screening.result.completed",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "order_id": "12345",
    "score": {
      "label": "Overall Risk",
      "value": "75",
      "min": "0",
      "max": "100"
    },
    "start_date": "2023-01-01T00:00:00Z",
    "submission_date": "2023-01-02T00:00:00Z",
    "summary": "Background check completed successfully",
    "status": "completed",
    "result_url": "https://example.com/results/12345"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Body

application/json
​
event
enum<string>
required

The event type

Available options:
screening.result.created,
screening.result.updated,
screening.result.completed,
screening.result.failed,
screening.result.cancelled
Example:

"screening.result.completed"

​
data
object
required

The result data

​
raw
object[] | null

Response

200
application/json
The screening result webhook was processed.
​
event
enum<string>
required

The event type

Available options:
screening.result.created,
screening.result.updated,
screening.result.completed,
screening.result.failed,
screening.result.cancelled
Example:

"screening.result.completed"

​
data
object
required

The result data

​
raw
object[] | null

Was this page helpful?

Raise issue