--- updatedAt: 2026-05-22T11:24:34.000Z agentTools: projectIndex: https://developer.skovik.com/llms.txt --- # List Export Orders **Required scope:** Read `export_orders` List all queued, completed and failed export orders. Usually not needed as part of a production workflow, but can be useful when exploring the API. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "version": "v1", "title": "Resources" }, "servers": [ { "url": "https://api.skovik.com/v1" } ], "paths": { "/users": { "get": { "operationId": "listUsers", "tags": [ "Users" ], "summary": "List Users", "description": "**Required scope:** Read `users`\n\nReturns a list of all users.\n\nThis endpoint is typically used to enumerate all users. It can also be used with filtering query params to return a single user (or a few).\nExamples of the latter are filtering on a `primary_email`, `external_identifier` or filtering on [metadata](https://developer.skovik.com/reference/api-metadata).\n\n> 📘 Filtered results\n> Note that when filtering the data is still returned as an array, but\n> assuming unique values, you can expect a single record (or empty list if no matching users were found).\n", "parameters": [ { "in": "query", "name": "primary_email", "schema": { "type": "string" }, "description": "Filter user list on primary email.", "example": "jane.doe@example.com" }, { "in": "query", "name": "external_identifier", "schema": { "type": "string" }, "description": "Filter user list on `external_identifier`.", "example": "acme-employee-001" }, { "in": "query", "name": "external_metadata", "schema": { "type": "object" }, "style": "deepObject", "explode": true, "description": "Filter user list on `external_metadata` values.", "example": { "pension_plan": "premium" } }, { "in": "query", "name": "starting_after", "schema": { "type": "string" }, "description": "Pagination cursor", "example": "51ce875242e653b2b6f090d1a0b6f5df" }, { "in": "query", "name": "ending_before", "schema": { "type": "string" }, "description": "Pagination cursor", "example": "51ce875242e653b2b6f090d1a0b6f5df" } ], "responses": { "200": { "description": "List of users", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1users/post/requestBody/content/application~1json/schema/properties/data" } }, "meta": { "type": "object", "readOnly": true, "properties": { "pagination": { "type": "object", "properties": { "current": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "examples": { "users": { "summary": "3 users", "value": { "data": [ { "$ref": "#/paths/~1users/post/responses/201/content/application~1json/examples/jane_doe/value/data" }, { "id": "a4ca67716af128ba14bae35f0cc1a6f7", "type": "users", "attributes": { "first_name": "Grace", "last_name": "Hopper", "primary_email": "grace.hopper@example.com", "roles": [ "finance" ], "external_identifier": "acme-employee-010", "external_metadata": { "department": "acme-finance", "pension_plan": "premium" } }, "relationships": { "branch": { "data": { "type": "branches", "id": "a1dc46dba8a15acebb217749e3b73ac7" } }, "superior": { "data": { "type": "users", "id": "51ce875242e653b2b6f090d1a0b6f5df" } }, "delegates": { "data": [ { "type": "users", "id": "5844a15e76563fedd11840fd6f40ea7b" } ] } } }, { "id": "51ce875242e653b2b6f090d1a0b6f5df", "type": "users", "attributes": { "first_name": "Ada", "last_name": "Lovelace", "primary_email": "ada.lovelace@example.com", "roles": [ "admin" ], "external_identifier": "acme-employee-011", "external_metadata": { "department": "acme-hr", "pension_plan": "premium" } } } ], "meta": { "pagination": { "total": 1, "current": 1 } } } }, "empty_list": { "summary": "0 users", "value": { "data": [], "meta": { "pagination": { "total": 0, "current": 1 } } } } } } } } } }, "post": { "operationId": "createUser", "tags": [ "Users" ], "summary": "Create a User", "description": "**Required scope:** Write `users`\n\nCreate a user\n\n> 📘 Branch and role branches relationships\n> The branch and role branches relationships are required only if you are using branches.\n> If you aren't using branches, you can simply disregard these relationships.\n\n> 📘 External identifier\n> The `external_identifier` is optional and can be used for employee-id like values.\n> It will be searchable within Skovik, which can be useful for administrators.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "attributes" ], "properties": { "type": { "type": "string", "readOnly": true, "enum": [ "users" ] }, "id": { "type": "string", "readOnly": true }, "attributes": { "type": "object", "required": [ "first_name", "last_name", "primary_email" ], "properties": { "first_name": { "type": "string", "minLength": 1, "maxLength": 30, "description": "First name" }, "last_name": { "type": "string", "minLength": 1, "maxLength": 30, "description": "Last name" }, "primary_email": { "type": "string", "minLength": 5, "maxLength": 100, "description": "Primary email" }, "roles": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ], "enum": [ "finance", "admin", "employee_manager", "exporter", "analyst", "null" ] }, "description": "User roles" }, "external_identifier": { "type": "string", "maxLength": 50, "description": "External identifier, for example employee ID, searchable in the Skovik UI." }, "external_metadata": { "type": "object", "additionalProperties": true, "description": "A set of key/value pairs for the user.\nUseful for storing additional information about the user in a structured format.\n" }, "custom_fields": { "type": "object", "additionalProperties": true, "description": "Hash of custom field key + value pairs, with each pair specifying the value of the custom field\nfor this user.\n" } } }, "relationships": { "type": "object", "properties": { "superior": { "type": [ "object", "null" ], "properties": { "data": { "type": [ "object", "null" ], "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "users" ] }, "id": { "type": "string" } } } } }, "branch": { "type": [ "object", "null" ], "properties": { "data": { "type": [ "object", "null" ], "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "branches" ] }, "id": { "type": "string" } } } } }, "delegates": { "type": [ "object", "null" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1users/post/requestBody/content/application~1json/schema/properties/data/properties/relationships/properties/superior/properties/data" } } } }, "role_branches": { "type": [ "object", "null" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1users/post/requestBody/content/application~1json/schema/properties/data/properties/relationships/properties/branch/properties/data" } } } } } } } }, "meta": { "type": "object", "properties": { "welcome": { "type": [ "string", "null" ], "enum": [ "yes" ], "description": "Controls if the user should receive a welcome email. The only accepted value is `yes`.\nIf the parameter is not set no email is sent.\n" }, "welcome_locale": { "type": [ "string", "null" ], "enum": [ "en", "sv", "de", "fi", "pl", "nb", "da", "fr", "es" ], "description": "The locale of the welcome email. The locale must be one that is supported by Skovik,\nfor example \"en\" or \"sv\". If no locale is provided, English will be used.\n" } } } } }, "examples": { "jane_doe": { "summary": "Create user 'Jane Doe'", "value": { "data": { "attributes": { "first_name": "Jane", "last_name": "Doe", "primary_email": "jane.doe@example.com", "external_identifier": "acme-employee-001", "external_metadata": { "department": "acme-sales", "pension_plan": "premium" }, "custom_fields": { "employee_id": "acme-001" } } }, "meta": { "welcome": "yes", "welcome_locale": "en" } } } } } } }, "responses": { "201": { "description": "User created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1users~1{user_id}/patch/requestBody/content/application~1json/schema" }, "examples": { "jane_doe": { "value": { "data": { "id": "5844a15e76563fedd11840fd6f40ea7b", "type": "users", "attributes": { "first_name": "Jane", "last_name": "Doe", "primary_email": "jane.doe@example.com", "roles": [], "external_identifier": "acme-employee-001", "external_metadata": { "department": "acme-sales", "pension_plan": "premium" }, "custom_fields": { "employee_id": "acme-001" } } } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1ping/get/responses/401/content/application~1json/schema" }, "example": { "errors": [ { "id": "ee249b2c-5b1e-4441-bf86-9e08ad9d12c8", "status": "400", "title": "Bad request", "detail": "Invalid email", "code": "email_exists" } ] } } } } } } }, "/export_orders": { "get": { "operationId": "listExportOrders", "tags": [ "Export Orders" ], "summary": "List Export Orders", "description": "**Required scope:** Read `export_orders`\n\nList all queued, completed and failed export orders.\nUsually not needed as part of a production workflow, but can be useful when exploring the API.\n", "parameters": [ { "in": "query", "name": "starting_after", "schema": { "type": "string" }, "description": "Pagination cursor", "example": "51ce875242e653b2b6f090d1a0b6f5df" }, { "in": "query", "name": "ending_before", "schema": { "type": "string" }, "description": "Pagination cursor", "example": "51ce875242e653b2b6f090d1a0b6f5df" } ], "responses": { "200": { "description": "List of export orders", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/paths/~1export_orders/post/requestBody/content/application~1json/schema/properties/data" } }, "meta": { "$ref": "#/paths/~1users/get/responses/200/content/application~1json/schema/properties/meta" } } }, "examples": { "export_orders_list": { "summary": "3 export orders", "value": { "data": [ { "$ref": "#/paths/~1export_orders/post/responses/201/content/application~1json/examples/created_order/value/data" }, { "id": "7b2f31b90fe1c2cc33a52233c1925df3", "type": "export_orders", "attributes": { "format": "payroll", "state": "queued", "error_message": null, "options": { "start_time": "2001-02-01T00:00:00Z", "stop_time": "2001-03-01T00:00:00Z" }, "files": [] }, "relationships": { "branch": { "data": { "type": "branches", "id": "a1dc46dba8a15acebb217749e3b73ac7" } } } }, { "id": "d7c8c85bf79bbe1b7188497c32c3b0ca", "type": "export_orders", "attributes": { "format": "payroll", "state": "failed", "error_message": "No data found to export for the selected options", "options": { "start_time": "2001-03-01T00:00:00Z", "stop_time": "2001-04-01T00:00:00Z" }, "files": [] }, "relationships": { "branch": { "data": { "type": "branches", "id": "a1dc46dba8a15acebb217749e3b73ac7" } } } } ], "meta": { "pagination": { "total": 1, "current": 1 } } } }, "empty_list": { "summary": "0 export orders", "value": { "data": [], "meta": { "pagination": { "total": 0, "current": 1 } } } } } } } } } }, "post": { "operationId": "createExportOrder", "tags": [ "Export Orders" ], "summary": "Create an Export Order", "description": "**Required scope:** Write `export_orders`\n\nSince exports are processed asynchronously the files aren't available immediately. We recommend subscribing to the `export_orders.completed` and `export_orders.failed` webhook events so you are notified the moment the export is ready, rather than polling. Polling the export order every 10-60 seconds also works for environments where running a webhook receiver is not practical. When the export state is `completed`, the files can be downloaded.\n\nLarge exports may take a few minutes to complete.\n\nSome formats have fine-grained options (unique to each format). For example, for some exports the file format can be adjusted (e.g. between [CSV](https://www.ietf.org/rfc/rfc4180.txt) and [JSON Lines](https://jsonlines.org)). Use the [List Available Formats](https://developer.skovik.com/reference/listexportorderformats) endpoint to see available options for each format.\n\n> 🚧 Concurrency Limit\n> At most two export orders may be queued at any time. When exceeded a `403` status code (forbidden) is returned. With typical use this should not pose a problem.\n\n> 📘 Empty Interval\n> If no reports are available in the chosen time interval (and branch), the export order will get the state `failed` and the related message will be in the `error_message` attribute.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "attributes" ], "properties": { "type": { "type": "string", "readOnly": true, "enum": [ "export_orders" ] }, "id": { "type": "string", "readOnly": true }, "attributes": { "type": "object", "properties": { "format": { "type": "string", "description": "Export format. The list of example values is incomplete and we add new export formats on a regular basis.\nSee [formats endpoint](https://developer.skovik.com/reference/listexportorderformats) for details.\n", "enum": [ "aditro", "agda", "bookkeeping", "carbon_footprint", "expense_transactions", "hogia_plus", "paxml", "payroll", "receipts", "sie" ] }, "options": { "type": "object", "writeOnly": true, "properties": { "start_time": { "type": "string", "format": "date-time", "example": "2021-12-24T12:00:00Z", "description": "Lower bound timestamp in the ISO-8601 format.\nA restricted range of formats defined by [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601), as specified in [W3C Note on timestamps](https://www.w3.org/TR/NOTE-datetime)\n" }, "stop_time": { "type": "string", "format": "date-time", "example": "2021-12-24T17:42:24Z", "description": "Upper bound timestamp in the ISO-8601 format.\nA restricted range of formats defined by [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601), as specified in [W3C Note on timestamps](https://www.w3.org/TR/NOTE-datetime)\n" } }, "additionalProperties": true, "description": "A set of key/value options specific to the format.\nSee [formats endpoint](https://developer.skovik.com/reference/listexportorderformats) for details about the available options.\n" }, "state": { "type": "string", "readOnly": true, "enum": [ "queued", "completed", "failed" ], "description": "Export orders are always in one of three states: queued, completed or failed.\n- `queued` -> The export is queued for processing.\n- `completed` -> The export is completed and files are ready for download.\n- `failed` -> Export failed, `error_message` is available.\n" }, "error_message": { "type": [ "string", "null" ], "readOnly": true, "description": "More descriptive error message if the state is `failed`\n" }, "files": { "type": "array", "readOnly": true, "items": { "type": "string", "format": "url" }, "description": "URLs to the completed exported files.\nSince exports are processed asynchronously the files aren't available immediately. Poll with some frequency (every ~10 seconds should work well) and when state is `completed` the files can be downloaded.\n\nMost exports result in small files (less than 1 MB) and are ready within a few seconds. For large amounts of data you need to wait a little longer.\n\nAll current export formats always generate a single file in the `files` array (but future formats or very large exports may generate more than one file).\n\n> 📘 Downloading Files\n> When downloading files we may issue a redirect, for example a status code `302` or `307`, to the final location of a file. A well-behaved HTTP client will follow redirects by default, make sure that the client you are using follows redirects.\n>\n> The URLs that files are served from may change over time. Make sure you don't hard-code or assume that files will be downloaded from a specific domain.\n\n> 📘 Filenames\n> Sometimes the filename is needed. It is provided via the Content-Disposition header and its filename parameter. More details and examples can be found in [RFC 6266](https://tools.ietf.org/html/rfc6266#section-5).\n" } } }, "relationships": { "type": "object", "required": [ "branch" ], "properties": { "branch": { "type": "object", "properties": { "data": { "$ref": "#/paths/~1users/post/requestBody/content/application~1json/schema/properties/data/properties/relationships/properties/branch/properties/data" } } } } } } } } }, "examples": { "createOrder": { "summary": "Create export order", "value": { "data": { "attributes": { "format": "payroll", "options": { "variant": "jsonl", "start_time": "2001-01-01T00:00:00Z", "stop_time": "2001-02-01T00:00:00Z" } } } } } } } } }, "responses": { "201": { "description": "Export order created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1export_orders/post/requestBody/content/application~1json/schema" }, "examples": { "created_order": { "value": { "data": { "id": "07ca5050e697392c9ed47e6453f1453f", "type": "export_orders", "attributes": { "format": "payroll", "state": "completed", "error_message": null, "options": { "start_time": "2001-01-01T00:00:00Z", "stop_time": "2001-02-01T00:00:00Z" }, "files": [ "https://facade.skovik.net/facade/e/07ca5050e697392c9ed47e6453f1453f?signature=fa1" ] }, "relationships": { "branch": { "data": { "type": "branches", "id": "a1dc46dba8a15acebb217749e3b73ac7" } } } } } } } } } }, "400": { "$ref": "#/paths/~1users/post/responses/400" } } } } }, "webhooks": { "export_orders": { "post": { "operationId": "webhookExportOrder", "tags": [ "Webhooks" ], "summary": "Export order created, completed, or failed", "description": "Delivered when an export order is created, completes or fails. The three events share the same payload structure and are distinguished by the `type` field.\n\n- `export_orders.created`: the export order has been created.\n- `export_orders.completed`: the export order completed successfully. Fetch the order via the [Read export order](https://developer.skovik.com/reference/readexportorder) endpoint to obtain the URL to the export file.\n- `export_orders.failed`: the export order failed. Fetch the order via the [Read export order](https://developer.skovik.com/reference/readexportorder) endpoint and inspect the `error_message` attribute for details.\n", "security": [], "parameters": [ { "$ref": "#/webhooks/users/post/parameters/0" }, { "$ref": "#/webhooks/users/post/parameters/1" }, { "$ref": "#/webhooks/users/post/parameters/2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "type", "timestamp", "data" ], "properties": { "id": { "type": "string", "description": "Delivery id, matching the `webhook-id` header.", "example": "60c7d63a8f4c4b9e9c2e1a2b" }, "type": { "type": "string", "enum": [ "export_orders.created", "export_orders.completed", "export_orders.failed" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "When this delivery attempt was signed and dispatched.", "example": "2026-05-25T14:30:45Z" }, "data": { "allOf": [ { "$ref": "#/webhooks/misc.ping/post/requestBody/content/application~1json/schema/properties/data" }, { "type": "object", "required": [ "relationships" ], "properties": { "relationships": { "type": "object", "required": [ "related_object" ], "properties": { "related_object": { "type": "object", "required": [ "data", "links" ], "properties": { "data": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "export_orders" ] }, "id": { "type": "string", "example": "f3a9c7e15b344a8cb6f122b0" } } }, "links": { "type": "object", "required": [ "related" ], "properties": { "related": { "type": "string", "example": "/v1/export_orders/f3a9c7e15b344a8cb6f122b0" } } } } } } } } } ] } } }, "example": { "id": "60c7d63a8f4c4b9e9c2e1a2b", "type": "export_orders.completed", "timestamp": "2026-05-25T14:30:45Z", "data": { "id": "8b1d4f122c0e4b1a9f9d3d0e", "type": "webhook_events", "attributes": { "created_at": "2026-05-25T14:30:45Z", "name": "export_orders.completed" }, "links": { "self": "/v1/webhook_events/8b1d4f122c0e4b1a9f9d3d0e" }, "relationships": { "related_object": { "data": { "type": "export_orders", "id": "f3a9c7e15b344a8cb6f122b0" }, "links": { "related": "/v1/export_orders/f3a9c7e15b344a8cb6f122b0" } } } } } } } }, "responses": { "410": { "description": "The endpoint will be disabled immediately. No further events are sent until it is re-enabled in the Skovik UI." }, "2XX": { "description": "Successful delivery and verification of the webhook event." }, "default": { "description": "Any other response code will be treated as a failure and scheduled for retry with exponential backoff." } } } }, "branches": { "post": { "operationId": "webhookBranch", "tags": [ "Webhooks" ], "summary": "Branch created, updated, or archived", "description": "Delivered when a branch is created, updated or archived. The three events are distinguished by the `type` field. Fetch the branch via the [Read branch](https://developer.skovik.com/reference/readbranch) endpoint to obtain its current state.\n\n- `branches.created`: the branch has been created.\n- `branches.updated`: one or more of the branch's attributes have changed.\n- `branches.archived`: the branch has been archived.\n", "security": [], "parameters": [ { "$ref": "#/webhooks/users/post/parameters/0" }, { "$ref": "#/webhooks/users/post/parameters/1" }, { "$ref": "#/webhooks/users/post/parameters/2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "type", "timestamp", "data" ], "properties": { "id": { "type": "string", "description": "Delivery id, matching the `webhook-id` header.", "example": "2a9f8e7d6c5b4a3928170615" }, "type": { "type": "string", "enum": [ "branches.created", "branches.updated", "branches.archived" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "When this delivery attempt was signed and dispatched.", "example": "2026-05-25T14:30:45Z" }, "data": { "allOf": [ { "$ref": "#/webhooks/misc.ping/post/requestBody/content/application~1json/schema/properties/data" }, { "type": "object", "required": [ "relationships" ], "properties": { "relationships": { "type": "object", "required": [ "related_object" ], "properties": { "related_object": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "branches" ] }, "id": { "type": "string", "example": "6b5a4938271605f4e3d2c1b0" } } }, "links": { "type": "object", "description": "A link to the API resource the event pertains to. Omitted for `branches.archived`.", "required": [ "related" ], "properties": { "related": { "type": "string", "example": "/v1/branches/6b5a4938271605f4e3d2c1b0" } } } } } } } } } ] } } }, "example": { "id": "2a9f8e7d6c5b4a3928170615", "type": "branches.created", "timestamp": "2026-05-25T14:30:45Z", "data": { "id": "9d8c7b6a5e4f3a2b1c0d9e8f", "type": "webhook_events", "attributes": { "created_at": "2026-05-25T14:30:45Z", "name": "branches.created" }, "links": { "self": "/v1/webhook_events/9d8c7b6a5e4f3a2b1c0d9e8f" }, "relationships": { "related_object": { "data": { "type": "branches", "id": "6b5a4938271605f4e3d2c1b0" }, "links": { "related": "/v1/branches/6b5a4938271605f4e3d2c1b0" } } } } } } } }, "responses": { "410": { "description": "The endpoint will be disabled immediately. No further events are sent until it is re-enabled in the Skovik UI." }, "2XX": { "description": "Successful delivery and verification of the webhook event." }, "default": { "description": "Any other response code will be treated as a failure and scheduled for retry with exponential backoff." } } } }, "users": { "post": { "operationId": "webhookUser", "tags": [ "Webhooks" ], "summary": "User created, updated, or archived", "description": "Delivered when a user is created, updated or archived. The three events are distinguished by the `type` field. Fetch the user via the [Read user](https://developer.skovik.com/reference/readuser) endpoint to obtain its current state.\n\n- `users.created`: the user has been created.\n- `users.updated`: some part of the user object in the API has changed.\n- `users.archived`: the user has been archived.\n", "security": [], "parameters": [ { "in": "header", "name": "webhook-id", "required": true, "schema": { "type": "string", "example": "60c7d63a8f4c4b9e9c2e1a2b" }, "description": "Unique identifier for this delivery. Stable across retries." }, { "in": "header", "name": "webhook-timestamp", "required": true, "schema": { "type": "string", "example": "1748353845" }, "description": "Unix timestamp in seconds." }, { "in": "header", "name": "webhook-signature", "required": true, "schema": { "type": "string", "example": "v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE=" }, "description": "HMAC-SHA256 signature of the payload following the Standard Webhooks specification." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "type", "timestamp", "data" ], "properties": { "id": { "type": "string", "description": "Delivery id, matching the `webhook-id` header.", "example": "7f2c1a980b5e4d6f8a3c2b11" }, "type": { "type": "string", "enum": [ "users.created", "users.updated", "users.archived" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "When this delivery attempt was signed and dispatched.", "example": "2026-05-25T14:30:45Z" }, "data": { "allOf": [ { "$ref": "#/webhooks/misc.ping/post/requestBody/content/application~1json/schema/properties/data" }, { "type": "object", "required": [ "relationships" ], "properties": { "relationships": { "type": "object", "required": [ "related_object" ], "properties": { "related_object": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "users" ] }, "id": { "type": "string", "example": "5c1e0b9a7d234f6a8b1c2d3e" } } }, "links": { "type": "object", "description": "A link to the API resource the event pertains to. Omitted for `users.archived`.", "required": [ "related" ], "properties": { "related": { "type": "string", "example": "/v1/users/5c1e0b9a7d234f6a8b1c2d3e" } } } } } } } } } ] } } }, "example": { "id": "7f2c1a980b5e4d6f8a3c2b11", "type": "users.updated", "timestamp": "2026-05-25T14:30:45Z", "data": { "id": "4e5d6c7b8a91023f4d5e6a7b", "type": "webhook_events", "attributes": { "created_at": "2026-05-25T14:30:45Z", "name": "users.updated" }, "links": { "self": "/v1/webhook_events/4e5d6c7b8a91023f4d5e6a7b" }, "relationships": { "related_object": { "data": { "type": "users", "id": "5c1e0b9a7d234f6a8b1c2d3e" }, "links": { "related": "/v1/users/5c1e0b9a7d234f6a8b1c2d3e" } } } } } } } }, "responses": { "410": { "description": "The endpoint will be disabled immediately. No further events are sent until it is re-enabled in the Skovik UI." }, "2XX": { "description": "Successful delivery and verification of the webhook event." }, "default": { "description": "Any other response code will be treated as a failure and scheduled for retry with exponential backoff." } } } }, "misc.ping": { "post": { "operationId": "webhookMiscPing", "tags": [ "Webhooks" ], "summary": "misc.ping", "description": "Manual test event triggered from the UI. See [Managing webhook endpoints](https://developer.skovik.com/docs/api-webhooks) for details.\n", "security": [], "parameters": [ { "$ref": "#/webhooks/users/post/parameters/0" }, { "$ref": "#/webhooks/users/post/parameters/1" }, { "$ref": "#/webhooks/users/post/parameters/2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Manual test event triggered from the UI. Not subscribable. Has no related resource, so the inner `relationships` key is omitted.", "required": [ "id", "type", "timestamp", "data" ], "properties": { "id": { "type": "string", "description": "Delivery id, matching the `webhook-id` header.", "example": "1d3b9a440c2f4ad78a1f9e3f" }, "type": { "type": "string", "enum": [ "misc.ping" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "When this delivery attempt was signed and dispatched.", "example": "2026-05-25T14:30:45Z" }, "data": { "type": "object", "required": [ "id", "type", "attributes", "links" ], "properties": { "id": { "type": "string", "description": "Inner event id. Distinct from the top-level delivery id, and identical across deliveries of the same event (even to multiple endpoints).", "example": "8b1d4f122c0e4b1a9f9d3d0e" }, "type": { "type": "string", "enum": [ "webhook_events" ] }, "attributes": { "type": "object", "required": [ "created_at", "name" ], "properties": { "created_at": { "type": "string", "format": "date-time", "example": "2026-05-25T14:30:45Z" }, "name": { "type": "string", "description": "Event name, matching the top-level `type` field." } } }, "links": { "type": "object", "required": [ "self" ], "properties": { "self": { "type": "string", "example": "/v1/webhook_events/8b1d4f122c0e4b1a9f9d3d0e" } } } } } } }, "example": { "id": "1d3b9a440c2f4ad78a1f9e3f", "type": "misc.ping", "timestamp": "2026-05-25T14:30:45Z", "data": { "id": "8c2e0c9a4d114d5e91b33a7c", "type": "webhook_events", "attributes": { "created_at": "2026-05-25T14:30:45Z", "name": "misc.ping" }, "links": { "self": "/v1/webhook_events/8c2e0c9a4d114d5e91b33a7c" } } } } } }, "responses": { "410": { "description": "The endpoint will be disabled immediately. No further events are sent until it is re-enabled in the Skovik UI." }, "2XX": { "description": "Successful delivery and verification of the webhook event." }, "default": { "description": "Any other response code, as well as a timeout or connection error, is treated as a failed delivery. Unlike subscribable events, a ping is never retried." } } } } }, "security": [ { "ApiKey": [] } ], "components": { "securitySchemes": { "ApiKey": { "type": "http", "scheme": "bearer" } } }, "x-readme": { "proxy-enabled": false, "samples-languages": [ "curl", "csharp", "ruby", "node", "python" ] } } ```