TypeScript SDK

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

const { data: signing } = await partnersApi.getPartnerEntryContextSigning({ partnerId });
console.log(signing.secretSet, signing.required);

import requests

url = "https://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing', 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://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing"

	req, _ := http.NewRequest("GET", 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://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing")

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

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

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

{
  "success": true,
  "data": {
    "partnerId": "3f2b8f0e-5b52-4c11-9a52-0f1f4a2d9c11",
    "required": false,
    "secretSet": true,
    "secretRotatedAt": "2026-10-11T08:00:00.000Z",
    "previousSecretValidUntil": null,
    "signingAvailable": true
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Partners

See how the context of your embeds is signed

Says whether you have a secret to sign the context of your embeds with, when it was made, whether the secret it replaced is still accepted, and whether an entry without a valid signature is refused (required). The secret itself is never part of the answer: it is shown once, when it is made (rotatePartnerEntryContextSecret, which also explains what signing is for and how to sign).

Signing covers the entries written through the gateway into the compositions of your managed users and into those of your own account. The caller must be the person who administers the partner (an API key of that account works, with the partner:read scope), or a Widgetic administrator.

GET

partners

{partnerId}

entry-context-signing

TypeScript SDK

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

const { data: signing } = await partnersApi.getPartnerEntryContextSigning({ partnerId });
console.log(signing.secretSet, signing.required);

import requests

url = "https://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing', 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://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing"

	req, _ := http.NewRequest("GET", 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://api.widgetic.com/v1/partners/{partnerId}/entry-context-signing")

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

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

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

{
  "success": true,
  "data": {
    "partnerId": "3f2b8f0e-5b52-4c11-9a52-0f1f4a2d9c11",
    "required": false,
    "secretSet": true,
    "secretRotatedAt": "2026-10-11T08:00:00.000Z",
    "previousSecretValidUntil": null,
    "signingAvailable": true
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId

string<uuid>

required

The partner whose context signing to read

Response

How the context of your embeds is signed

success

boolean

required

Always true on a success.

Example:

true

data

object

required

How the context of your embeds is signed. The secret that signs it is never part of this: it is shown once, when it is made.

Show child attributes

Example:

{
  "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "required": true,
  "secretSet": true,
  "secretRotatedAt": "2026-01-15T09:30:00.000Z",
  "previousSecretValidUntil": "2026-01-15T09:30:00.000Z",
  "signingAvailable": true
}

API Reference

Public Embed

Workflows

Partners

Widgets

Users

Uploads

Tokens

Operations

Managed Users

Invoices

Entitlements

Credits

Compositions

Canvases

Brand Kit

See how the context of your embeds is signed

Authorizations

Path Parameters

Response