Send a test event to a webhook

curl --request POST \
  --url https://app.sajn.se/api/v1/webhooks/{id}/test \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.sajn.se/api/v1/webhooks/{id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sajn.se/api/v1/webhooks/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sajn.se/api/v1/webhooks/{id}/test"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/webhooks/{id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "cm4k2x9p10013abcd1234efgh",
  "webhookId": "cm4k2x9p10013abcd1234efgh",
  "eventId": "cm4k2x9p10014abcd1234efgh",
  "type": "document.created",
  "status": "SUCCESS",
  "url": "https://example.com/webhooks/sajn",
  "replayOfId": null,
  "requestBody": {
    "id": "cm4k2x9p10014abcd1234efgh",
    "type": "document.fully_signed",
    "createdAt": "2026-09-29T07:41:00.000Z",
    "apiVersion": "2026-10",
    "workspaceId": "cm4k2x9p10001abcd1234efgh",
    "environment": "PRODUCTION",
    "actor": null,
    "data": {
      "object": {
        "id": "cm4k2x9p10003abcd1234efgh",
        "externalId": "HR-2026-0142",
        "expiresAt": "2026-10-28T22:00:00.000Z",
        "name": "Anställningsavtal – Kai Lindqvist",
        "status": "PENDING",
        "documentMeta": {
          "subject": "Ditt anställningsavtal från Exempelbolaget AB",
          "message": "Hej Kai! Här är ditt anställningsavtal. Signera det med BankID senast den 28 oktober.",
          "signingMode": "PARALLEL",
          "forceReadFullDocument": true,
          "showChatToSigners": false,
          "language": "sv",
          "value": null,
          "redirectUrl": null,
          "redirectEnabled": false,
          "internalRecipients": [
            "[email protected]"
          ],
          "signableAfterExpired": false,
          "sendPlainTextEmailOnly": null,
          "reminderIntervalDays": 3,
          "allowDelegation": false,
          "accessVerification": "NONE",
          "aiChatEnabled": null,
          "nationalIdDisplayMode": null,
          "sameDeviceSigning": false,
          "documentCategoryId": "cm4k2x9p10017abcd1234efgh"
        },
        "createdAt": "2026-09-28T09:12:00.000Z",
        "updatedAt": "2026-09-29T07:41:00.000Z",
        "completedAt": null,
        "deletedAt": null,
        "templateId": "cm4k2x9p10008abcd1234efgh",
        "folderId": "cm4k2x9p10011abcd1234efgh",
        "responsibleUserId": "cm4k2x9p10002abcd1234efgh",
        "parties": [
          {
            "id": "cm4k2x9p10004abcd1234efgh",
            "documentId": "cm4k2x9p10003abcd1234efgh",
            "email": "[email protected]",
            "name": "Kai Lindqvist",
            "phone": "+46701740605",
            "type": "INDIVIDUAL",
            "company": null,
            "externalId": "EMP-0142",
            "contactId": "cm4k2x9p10006abcd1234efgh",
            "nationalId": null,
            "country": "SE",
            "role": "SIGNER",
            "signingOrder": 1,
            "signedAt": "2026-09-29T07:41:00.000Z",
            "readStatus": "READ",
            "signingStatus": "SIGNED",
            "deliveryMethod": "EMAIL",
            "requiredSignature": "SE_BANKID",
            "twoStepVerification": "NONE",
            "sendStatus": "DELIVERED",
            "identityVerified": true,
            "identityMismatch": false,
            "createdAt": "2026-09-28T09:12:00.000Z"
          }
        ],
        "tags": [],
        "customFields": [],
        "fields": null,
        "productTables": [],
        "approvalRequestId": null
      }
    }
  },
  "attempts": [
    {
      "id": "cm4k2x9p10013abcd1234efgh",
      "attempt": 1,
      "status": "SUCCESS",
      "responseCode": 200,
      "durationMs": 1,
      "requestHeaders": {
        "startdatum": "Anställningsavtal – Kai Lindqvist"
      },
      "responseHeaders": {
        "startdatum": "Anställningsavtal – Kai Lindqvist"
      },
      "responseBody": null,
      "createdAt": "2026-09-28T09:12:00.000Z"
    }
  ],
  "createdAt": "2026-09-28T09:12:00.000Z"
}

{
  "code": "INVALID_API_VERSION",
  "message": "Unknown API version \"2026-13\". Supported versions: 2026-09, 2026-10.",
  "userMessage": "API-versionen finns inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API token",
  "userMessage": "Ogiltig API-nyckel",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "Insufficient OAuth scope: requires webhooks:write",
  "userMessage": "Applikationen saknar behörighet (scope) för denna åtgärd.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "requiredScopes": [
    "webhooks:write"
  ],
  "grantedScopes": [
    "profile:read"
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Webhook not found",
  "userMessage": "Resursen hittades inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "resource": "webhook"
}

{
  "code": "INVALID_STATE",
  "message": "The resource's current state doesn't allow the operation, such as editing a document that was already sent or downloading a file that isn't produced yet.",
  "userMessage": "Åtgärden är inte möjlig i resursens nuvarande status.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "RATE_LIMITED",
  "message": "API rate limit exceeded",
  "userMessage": "För många förfrågningar. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "userMessage": "Något gick fel.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "message": "A service the operation depends on, such as an eID provider or a connected integration, failed or is unavailable. Retry with exponential backoff.",
  "userMessage": "En extern tjänst svarar inte just nu. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

Webhooks

Send a test event to a webhook

Sends a webhook.test event to this webhook only, signed and delivered like any other event in the webhook’s API version, and returns the delivery with status: PENDING. data.object is the webhook’s id and url. Follow the delivery with GET /api/v1/webhooks/:id/deliveries/:deliveryId. The event isn’t listed in GET /api/v1/events, and no other webhook receives it.

Returns 409 INVALID_STATE when the webhook is disabled or paused.

Plan Requirement: Requires the Team plan or higher, or a sandbox organization.

POST

api

webhooks

{id}

test

Send a test event to a webhook

curl --request POST \
  --url https://app.sajn.se/api/v1/webhooks/{id}/test \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.sajn.se/api/v1/webhooks/{id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sajn.se/api/v1/webhooks/{id}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sajn.se/api/v1/webhooks/{id}/test"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/webhooks/{id}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "cm4k2x9p10013abcd1234efgh",
  "webhookId": "cm4k2x9p10013abcd1234efgh",
  "eventId": "cm4k2x9p10014abcd1234efgh",
  "type": "document.created",
  "status": "SUCCESS",
  "url": "https://example.com/webhooks/sajn",
  "replayOfId": null,
  "requestBody": {
    "id": "cm4k2x9p10014abcd1234efgh",
    "type": "document.fully_signed",
    "createdAt": "2026-09-29T07:41:00.000Z",
    "apiVersion": "2026-10",
    "workspaceId": "cm4k2x9p10001abcd1234efgh",
    "environment": "PRODUCTION",
    "actor": null,
    "data": {
      "object": {
        "id": "cm4k2x9p10003abcd1234efgh",
        "externalId": "HR-2026-0142",
        "expiresAt": "2026-10-28T22:00:00.000Z",
        "name": "Anställningsavtal – Kai Lindqvist",
        "status": "PENDING",
        "documentMeta": {
          "subject": "Ditt anställningsavtal från Exempelbolaget AB",
          "message": "Hej Kai! Här är ditt anställningsavtal. Signera det med BankID senast den 28 oktober.",
          "signingMode": "PARALLEL",
          "forceReadFullDocument": true,
          "showChatToSigners": false,
          "language": "sv",
          "value": null,
          "redirectUrl": null,
          "redirectEnabled": false,
          "internalRecipients": [
            "[email protected]"
          ],
          "signableAfterExpired": false,
          "sendPlainTextEmailOnly": null,
          "reminderIntervalDays": 3,
          "allowDelegation": false,
          "accessVerification": "NONE",
          "aiChatEnabled": null,
          "nationalIdDisplayMode": null,
          "sameDeviceSigning": false,
          "documentCategoryId": "cm4k2x9p10017abcd1234efgh"
        },
        "createdAt": "2026-09-28T09:12:00.000Z",
        "updatedAt": "2026-09-29T07:41:00.000Z",
        "completedAt": null,
        "deletedAt": null,
        "templateId": "cm4k2x9p10008abcd1234efgh",
        "folderId": "cm4k2x9p10011abcd1234efgh",
        "responsibleUserId": "cm4k2x9p10002abcd1234efgh",
        "parties": [
          {
            "id": "cm4k2x9p10004abcd1234efgh",
            "documentId": "cm4k2x9p10003abcd1234efgh",
            "email": "[email protected]",
            "name": "Kai Lindqvist",
            "phone": "+46701740605",
            "type": "INDIVIDUAL",
            "company": null,
            "externalId": "EMP-0142",
            "contactId": "cm4k2x9p10006abcd1234efgh",
            "nationalId": null,
            "country": "SE",
            "role": "SIGNER",
            "signingOrder": 1,
            "signedAt": "2026-09-29T07:41:00.000Z",
            "readStatus": "READ",
            "signingStatus": "SIGNED",
            "deliveryMethod": "EMAIL",
            "requiredSignature": "SE_BANKID",
            "twoStepVerification": "NONE",
            "sendStatus": "DELIVERED",
            "identityVerified": true,
            "identityMismatch": false,
            "createdAt": "2026-09-28T09:12:00.000Z"
          }
        ],
        "tags": [],
        "customFields": [],
        "fields": null,
        "productTables": [],
        "approvalRequestId": null
      }
    }
  },
  "attempts": [
    {
      "id": "cm4k2x9p10013abcd1234efgh",
      "attempt": 1,
      "status": "SUCCESS",
      "responseCode": 200,
      "durationMs": 1,
      "requestHeaders": {
        "startdatum": "Anställningsavtal – Kai Lindqvist"
      },
      "responseHeaders": {
        "startdatum": "Anställningsavtal – Kai Lindqvist"
      },
      "responseBody": null,
      "createdAt": "2026-09-28T09:12:00.000Z"
    }
  ],
  "createdAt": "2026-09-28T09:12:00.000Z"
}

{
  "code": "INVALID_API_VERSION",
  "message": "Unknown API version \"2026-13\". Supported versions: 2026-09, 2026-10.",
  "userMessage": "API-versionen finns inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API token",
  "userMessage": "Ogiltig API-nyckel",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "Insufficient OAuth scope: requires webhooks:write",
  "userMessage": "Applikationen saknar behörighet (scope) för denna åtgärd.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "requiredScopes": [
    "webhooks:write"
  ],
  "grantedScopes": [
    "profile:read"
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Webhook not found",
  "userMessage": "Resursen hittades inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "resource": "webhook"
}

{
  "code": "INVALID_STATE",
  "message": "The resource's current state doesn't allow the operation, such as editing a document that was already sent or downloading a file that isn't produced yet.",
  "userMessage": "Åtgärden är inte möjlig i resursens nuvarande status.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "RATE_LIMITED",
  "message": "API rate limit exceeded",
  "userMessage": "För många förfrågningar. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "userMessage": "Något gick fel.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "message": "A service the operation depends on, such as an eID provider or a connected integration, failed or is unavailable. Retry with exponential backoff.",
  "userMessage": "En extern tjänst svarar inte just nu. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

Authorizations

Authorization

string

header

required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

Sajn-Version

enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:

2026-09,

2026-10

Idempotency-Key

string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

string

required

The webhook ID.

Response

200

string

required

ID of the delivery: one event sent to one endpoint, with every attempt to send it.

webhookId

string

required

The webhook ID.

eventId

string | null

required

ID of the event, as GET /api/v1/events/:id takes it. Null for a delivery made before sajn recorded it.

type

enum<string> | null

required

The event type, such as document.completed. Null for an event type that 2026-10 no longer has.

Available options:

document.created,

document.sent,

document.fully_signed,

document.completed,

document.rejected,

document.expired,

document.withdrawn,

document.updated,

document.deleted,

document.restored,

document.archived,

document.unarchived,

document.expiration_extended,

document.expiring_soon,

document.party.sent,

document.party.delivery_failed,

document.party.opened,

document.party.read,

document.party.signed,

document.party.rejected,

document.party.delegated,

document.party.auth_failed,

document.party.verified,

document.party.updated,

document.party.added,

document.party.removed,

document.party.reminded,

document.comment.created,

identity_check.created,

identity_check.sent,

identity_check.opened,

identity_check.verified,

identity_check.failed,

identity_check.cancelled,

contact.created,

contact.updated,

contact.deleted,

company.created,

company.updated,

company.deleted,

template.created,

template.updated,

template.deleted,

template.restored,

form.submitted,

workspace.created,

member.added,

member.invited,

member.invite_accepted,

approval_request.created,

approval_request.approved,

approval_request.rejected,

approval_request.cancelled,

login.completed,

login.failed,

security.document_downloaded,

security.documents_exported,

security.signature_identity_accessed,

security.member_removed,

security.member_role_changed,

security.role_updated,

security.workspace_retention_updated,

usage.limit_reached,

webhook.test,

null

status

enum<string>

required

SUCCESS when an attempt got a 2xx answer, FAILED when sajn stopped retrying, and PENDING while attempts remain.

Available options:

SUCCESS,

FAILED,

PENDING

url

string

required

The endpoint URL the delivery was sent to.

replayOfId

string | null

required

ID of the delivery this one replays. Null for an original delivery.

requestBody

object

required

The JSON body sent to the endpoint, in the webhook's API version. Null until the first attempt.

Example:

{
  "id": "cm4k2x9p10014abcd1234efgh",
  "type": "document.fully_signed",
  "createdAt": "2026-09-29T07:41:00.000Z",
  "apiVersion": "2026-10",
  "workspaceId": "cm4k2x9p10001abcd1234efgh",
  "environment": "PRODUCTION",
  "actor": null,
  "data": {
    "object": {
      "id": "cm4k2x9p10003abcd1234efgh",
      "externalId": "HR-2026-0142",
      "expiresAt": "2026-10-28T22:00:00.000Z",
      "name": "Anställningsavtal – Kai Lindqvist",
      "status": "PENDING",
      "documentMeta": {
        "subject": "Ditt anställningsavtal från Exempelbolaget AB",
        "message": "Hej Kai! Här är ditt anställningsavtal. Signera det med BankID senast den 28 oktober.",
        "signingMode": "PARALLEL",
        "forceReadFullDocument": true,
        "showChatToSigners": false,
        "language": "sv",
        "value": null,
        "redirectUrl": null,
        "redirectEnabled": false,
        "internalRecipients": ["[email protected]"],
        "signableAfterExpired": false,
        "sendPlainTextEmailOnly": null,
        "reminderIntervalDays": 3,
        "allowDelegation": false,
        "accessVerification": "NONE",
        "aiChatEnabled": null,
        "nationalIdDisplayMode": null,
        "sameDeviceSigning": false,
        "documentCategoryId": "cm4k2x9p10017abcd1234efgh"
      },
      "createdAt": "2026-09-28T09:12:00.000Z",
      "updatedAt": "2026-09-29T07:41:00.000Z",
      "completedAt": null,
      "deletedAt": null,
      "templateId": "cm4k2x9p10008abcd1234efgh",
      "folderId": "cm4k2x9p10011abcd1234efgh",
      "responsibleUserId": "cm4k2x9p10002abcd1234efgh",
      "parties": [
        {
          "id": "cm4k2x9p10004abcd1234efgh",
          "documentId": "cm4k2x9p10003abcd1234efgh",
          "email": "[email protected]",
          "name": "Kai Lindqvist",
          "phone": "+46701740605",
          "type": "INDIVIDUAL",
          "company": null,
          "externalId": "EMP-0142",
          "contactId": "cm4k2x9p10006abcd1234efgh",
          "nationalId": null,
          "country": "SE",
          "role": "SIGNER",
          "signingOrder": 1,
          "signedAt": "2026-09-29T07:41:00.000Z",
          "readStatus": "READ",
          "signingStatus": "SIGNED",
          "deliveryMethod": "EMAIL",
          "requiredSignature": "SE_BANKID",
          "twoStepVerification": "NONE",
          "sendStatus": "DELIVERED",
          "identityVerified": true,
          "identityMismatch": false,
          "createdAt": "2026-09-28T09:12:00.000Z"
        }
      ],
      "tags": [],
      "customFields": [],
      "fields": null,
      "productTables": [],
      "approvalRequestId": null
    }
  }
}

attempts

object[]

required

Every attempt, oldest first. Empty until the first attempt.

Show child attributes

createdAt

string<date-time>

required

When the webhook was created.

Get started

Core concepts

Guides

Webhooks

API fundamentals

Upgrading

sajn Login

API reference

Send a test event to a webhook

Authorizations

Headers

Path Parameters

Response