Embeds

Approved products and short-lived embed sessions.

List embed products

GET

https://api.pokerworks.io

/api/v1/management/embed-products

List approved embed products visible to a management token

List embed products › Responses

EmbedProductsResponse

object[] · required

Create embed session

POST

https://api.pokerworks.io

/api/v1/management/embed-sessions

Create a short-lived spectator embed session

Create embed session › Headers

x-idempotency-key

string · maxLength: 160

Optional retry key. Reusing the same key with the same request reissues a launch URL for the same active session.

Create embed session › Request Body

CreateEmbedSessionRequest

environment

string · enum · required

Enum values:

test

live

mode

string · enum · required

Enum values:

spectator

origin

string · uri · minLength: 1 · maxLength: 240 · required

productKey

string · minLength: 1 · maxLength: 120 · pattern: ^[a-z0-9-]+$ · required

projectId

string · minLength: 1 · maxLength: 160 · required

object · required

returnUrl

string · uri · minLength: 1 · maxLength: 2048

Create embed session › Responses

CreateEmbedSessionResponse

object · required

launchSecretTransport

string · enum · required

Enum values:

url_fragment

launchUrl

string · uri · required

POST/api/v1/management/embed-sessions

curl https://api.pokerworks.io/api/v1/management/embed-sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "environment": "test",
  "mode": "spectator",
  "origin": "https://www.example.com/path/to/resource",
  "productKey": "productKey",
  "projectId": "projectId",
  "returnUrl": "https://www.example.com/path/to/resource",
  "target": {
    "kind": "public_ring_product",
    "tableId": "tableId"
  }
}'

Example Request Body

{
  "environment": "test",
  "mode": "spectator",
  "origin": "https://www.example.com/path/to/resource",
  "productKey": "productKey",
  "projectId": "projectId",
  "returnUrl": "https://www.example.com/path/to/resource",
  "target": {
    "kind": "public_ring_product",
    "tableId": "tableId"
  }
}

json

Example Responses

{
  "embedSession": {
    "brand": "dropinpoker",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "expiresAt": "2024-08-25T15:00:00Z",
    "id": "id",
    "mode": "spectator",
    "openedAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "origin": "https://www.example.com/path/to/resource",
    "productKey": "productKey",
    "projectId": "projectId",
    "returnUrl": "https://www.example.com/path/to/resource",
    "ringGameId": "ringGameId",
    "status": "active",
    "tableId": "tableId",
    "trustMode": "human_only"
  },
  "launchSecretTransport": "url_fragment",
  "launchUrl": "https://www.example.com/path/to/resource"
}

json

application/json

Get embed session

GET

https://api.pokerworks.io

/api/v1/management/embed-sessions/{embedSessionId}

Read an embed session visible to a management token

Get embed session › path Parameters

embedSessionId

string · required

Parameter embedSessionId.

Get embed session › Responses

GetEmbedSessionResponse

object · required

GET/api/v1/management/embed-sessions/{embedSessionId}

curl https://api.pokerworks.io/api/v1/management/embed-sessions/:embedSessionId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "embedSession": {
    "brand": "dropinpoker",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "expiresAt": "2024-08-25T15:00:00Z",
    "id": "id",
    "mode": "spectator",
    "openedAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "origin": "https://www.example.com/path/to/resource",
    "productKey": "productKey",
    "projectId": "projectId",
    "returnUrl": "https://www.example.com/path/to/resource",
    "ringGameId": "ringGameId",
    "status": "active",
    "tableId": "tableId",
    "trustMode": "human_only"
  }
}

json

application/json

Open embed session

POST

https://api.pokerworks.io

/api/v1/embed-sessions/{embedSessionId}/open

Open a short-lived public spectator embed session

Open embed session › path Parameters

embedSessionId

string · required

Parameter embedSessionId.

Open embed session › Request Body

OpenEmbedSessionRequest

launchSecret

string · pattern: ^pwes_[A-Za-z0-9_-]{… · required

origin

string · uri · minLength: 1 · maxLength: 240 · required

tableId

string · minLength: 1 · maxLength: 160 · required

Open embed session › Responses

OpenEmbedSessionResponse

brand

string · enum · required

Enum values:

dropinpoker

pokerdeck

pokercanyon

embedSessionId

string · required

expiresAt

string · date-time · required

mode

string · enum · required

Enum values:

spectator

productKey

string · required

ringGameId

string · required

tableId

string · required

Webhooks Playground

Create embed session

POST

https://api.pokerworks.io

/api/v1/management/embed-sessions

Create a short-lived spectator embed session

Create embed session › Headers

x-idempotency-key

string · maxLength: 160

Optional retry key. Reusing the same key with the same request reissues a launch URL for the same active session.

Create embed session › Request Body

CreateEmbedSessionRequest

environment

string · enum · required

Enum values:

test

live

mode

string · enum · required

Enum values:

spectator

origin

string · uri · minLength: 1 · maxLength: 240 · required

productKey

string · minLength: 1 · maxLength: 120 · pattern: ^[a-z0-9-]+$ · required

projectId

string · minLength: 1 · maxLength: 160 · required

object · required

returnUrl

string · uri · minLength: 1 · maxLength: 2048

Create embed session › Responses

CreateEmbedSessionResponse

object · required

launchSecretTransport

string · enum · required

Enum values:

url_fragment

launchUrl

string · uri · required

Get embed session

GET

https://api.pokerworks.io

/api/v1/management/embed-sessions/{embedSessionId}

Read an embed session visible to a management token

Get embed session › path Parameters

embedSessionId

string · required

Parameter embedSessionId.

Get embed session › Responses

GetEmbedSessionResponse

object · required

Open embed session

POST

https://api.pokerworks.io

/api/v1/embed-sessions/{embedSessionId}/open

Open a short-lived public spectator embed session

Open embed session › path Parameters

embedSessionId

string · required

Parameter embedSessionId.

Open embed session › Request Body

OpenEmbedSessionRequest

launchSecret

string · pattern: ^pwes_[A-Za-z0-9_-]{… · required

origin

string · uri · minLength: 1 · maxLength: 240 · required

tableId

string · minLength: 1 · maxLength: 160 · required

Open embed session › Responses

OpenEmbedSessionResponse

brand

string · enum · required

Enum values:

dropinpoker

pokerdeck

pokercanyon

embedSessionId

string · required

expiresAt

string · date-time · required

mode

string · enum · required

Enum values:

spectator

productKey

string · required

ringGameId

string · required

tableId

string · required