Webhooks

Webhook endpoint and delivery operations.

List webhook endpoints

GET

https://api.pokerworks.io

/api/v1/management/webhook-endpoints

List webhook endpoints visible to a management token

List webhook endpoints › Responses

WebhookEndpointsResponse

object[] · required

GET/api/v1/management/webhook-endpoints

curl https://api.pokerworks.io/api/v1/management/webhook-endpoints \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "webhookEndpoints": [
    {
      "activeSecretVersionId": "activeSecretVersionId",
      "createdAt": "2024-08-25T15:00:00Z",
      "disabledAt": "2024-08-25T15:00:00Z",
      "environment": "test",
      "eventTypes": [
        "tournament.completed"
      ],
      "failureCount": 0,
      "id": "id",
      "label": "label",
      "lastFailureAt": "2024-08-25T15:00:00Z",
      "lastSuccessAt": "2024-08-25T15:00:00Z",
      "organizationId": "organizationId",
      "projectId": "projectId",
      "status": "pending_verification",
      "updatedAt": "2024-08-25T15:00:00Z",
      "url": "https://www.example.com/path/to/resource",
      "verifiedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create webhook endpoint

POST

https://api.pokerworks.io

/api/v1/management/webhook-endpoints

Create a reveal-once webhook endpoint signing secret

Create webhook endpoint › Request Body

CreateWebhookEndpointRequest

environment

string · enum · required

Enum values:

test

live

eventTypes

string[] · minItems: 1 · maxItems: 20 · required

Enum values:

tournament.completed

label

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

url

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

Create webhook endpoint › Responses

CreateWebhookEndpointResponse

object · required

POST/api/v1/management/webhook-endpoints

curl https://api.pokerworks.io/api/v1/management/webhook-endpoints \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "environment": "test",
  "eventTypes": [
    "tournament.completed"
  ],
  "label": "label",
  "projectId": "projectId",
  "url": "https://www.example.com/path/to/resource"
}'

Example Request Body

{
  "environment": "test",
  "eventTypes": [
    "tournament.completed"
  ],
  "label": "label",
  "projectId": "projectId",
  "url": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "signingSecret": {
    "id": "id",
    "plaintextSecret": "plaintextSecret",
    "version": 1
  },
  "webhookEndpoint": {
    "activeSecretVersionId": "activeSecretVersionId",
    "createdAt": "2024-08-25T15:00:00Z",
    "disabledAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "eventTypes": [
      "tournament.completed"
    ],
    "failureCount": 0,
    "id": "id",
    "label": "label",
    "lastFailureAt": "2024-08-25T15:00:00Z",
    "lastSuccessAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "projectId": "projectId",
    "status": "pending_verification",
    "updatedAt": "2024-08-25T15:00:00Z",
    "url": "https://www.example.com/path/to/resource",
    "verifiedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get webhook endpoint

GET

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}

Read a webhook endpoint visible to a management token

Get webhook endpoint › path Parameters

endpointId

string · required

Parameter endpointId.

Get webhook endpoint › Responses

GetWebhookEndpointResponse

object · required

GET/api/v1/management/webhook-endpoints/{endpointId}

curl https://api.pokerworks.io/api/v1/management/webhook-endpoints/:endpointId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "webhookEndpoint": {
    "activeSecretVersionId": "activeSecretVersionId",
    "createdAt": "2024-08-25T15:00:00Z",
    "disabledAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "eventTypes": [
      "tournament.completed"
    ],
    "failureCount": 0,
    "id": "id",
    "label": "label",
    "lastFailureAt": "2024-08-25T15:00:00Z",
    "lastSuccessAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "projectId": "projectId",
    "status": "pending_verification",
    "updatedAt": "2024-08-25T15:00:00Z",
    "url": "https://www.example.com/path/to/resource",
    "verifiedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Delete webhook endpoint

DELETE

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}

Delete a webhook endpoint without removing delivery evidence

Delete webhook endpoint › path Parameters

endpointId

string · required

Parameter endpointId.

Delete webhook endpoint › Responses

DeleteWebhookEndpointResponse

object · required

DELETE/api/v1/management/webhook-endpoints/{endpointId}

curl https://api.pokerworks.io/api/v1/management/webhook-endpoints/:endpointId \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "webhookEndpoint": {
    "activeSecretVersionId": "activeSecretVersionId",
    "createdAt": "2024-08-25T15:00:00Z",
    "disabledAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "eventTypes": [
      "tournament.completed"
    ],
    "failureCount": 0,
    "id": "id",
    "label": "label",
    "lastFailureAt": "2024-08-25T15:00:00Z",
    "lastSuccessAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "projectId": "projectId",
    "status": "pending_verification",
    "updatedAt": "2024-08-25T15:00:00Z",
    "url": "https://www.example.com/path/to/resource",
    "verifiedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update webhook endpoint

PATCH

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}

Update and verify a webhook endpoint

Update webhook endpoint › path Parameters

endpointId

string · required

Parameter endpointId.

Update webhook endpoint › Request Body

UpdateWebhookEndpointRequest

eventTypes

string[] · minItems: 1 · maxItems: 20

Enum values:

tournament.completed

label

string · minLength: 1 · maxLength: 120

status

string · enum

Enum values:

active

disabled

url

string · uri · minLength: 1 · maxLength: 2048

Update webhook endpoint › Responses

UpdateWebhookEndpointResponse

object · required

PATCH/api/v1/management/webhook-endpoints/{endpointId}

curl https://api.pokerworks.io/api/v1/management/webhook-endpoints/:endpointId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "eventTypes": [
    "tournament.completed"
  ],
  "label": "label",
  "status": "active",
  "url": "https://www.example.com/path/to/resource"
}'

Example Request Body

{
  "eventTypes": [
    "tournament.completed"
  ],
  "label": "label",
  "status": "active",
  "url": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "webhookEndpoint": {
    "activeSecretVersionId": "activeSecretVersionId",
    "createdAt": "2024-08-25T15:00:00Z",
    "disabledAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "eventTypes": [
      "tournament.completed"
    ],
    "failureCount": 0,
    "id": "id",
    "label": "label",
    "lastFailureAt": "2024-08-25T15:00:00Z",
    "lastSuccessAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "projectId": "projectId",
    "status": "pending_verification",
    "updatedAt": "2024-08-25T15:00:00Z",
    "url": "https://www.example.com/path/to/resource",
    "verifiedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Rotate webhook endpoint secret

POST

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}/rotate-secret

Rotate a webhook endpoint signing secret

Rotate webhook endpoint secret › path Parameters

endpointId

string · required

Parameter endpointId.

Rotate webhook endpoint secret › Responses

RotateWebhookEndpointSecretResponse

object · required

POST/api/v1/management/webhook-endpoints/{endpointId}/rotate-secret

curl https://api.pokerworks.io/api/v1/management/webhook-endpoints/:endpointId/rotate-secret \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "signingSecret": {
    "id": "id",
    "plaintextSecret": "plaintextSecret",
    "version": 1
  },
  "webhookEndpoint": {
    "activeSecretVersionId": "activeSecretVersionId",
    "createdAt": "2024-08-25T15:00:00Z",
    "disabledAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "eventTypes": [
      "tournament.completed"
    ],
    "failureCount": 0,
    "id": "id",
    "label": "label",
    "lastFailureAt": "2024-08-25T15:00:00Z",
    "lastSuccessAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "projectId": "projectId",
    "status": "pending_verification",
    "updatedAt": "2024-08-25T15:00:00Z",
    "url": "https://www.example.com/path/to/resource",
    "verifiedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List webhook deliveries

GET

https://api.pokerworks.io

/api/v1/management/webhook-deliveries

List webhook delivery attempts visible to a management token

List webhook deliveries › Responses

WebhookDeliveriesResponse

object[] · required

GET/api/v1/management/webhook-deliveries

curl https://api.pokerworks.io/api/v1/management/webhook-deliveries \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "webhookDeliveries": [
    {
      "attemptCount": 0,
      "attempts": [
        {
          "attemptNumber": 1,
          "completedAt": "2024-08-25T15:00:00Z",
          "errorCode": "errorCode",
          "errorMessage": "errorMessage",
          "id": "id",
          "latencyMs": 0,
          "responseSnippet": "responseSnippet",
          "secretVersionId": "secretVersionId",
          "startedAt": "2024-08-25T15:00:00Z",
          "status": "succeeded",
          "statusCode": 0
        }
      ],
      "createdAt": "2024-08-25T15:00:00Z",
      "endpointId": "endpointId",
      "endpointUrl": "https://www.example.com/path/to/resource",
      "environment": "test",
      "event": {
        "apiVersion": "apiVersion",
        "createdAt": "2024-08-25T15:00:00Z",
        "data": {
          "key": {}
        },
        "environment": "test",
        "id": "id",
        "integrity": {
          "botsAllowed": true,
          "declaredBotSeats": {
            "count": 0,
            "present": true
          },
          "supportEvidence": {
            "trustModePolicyRef": "docs/architecture/developer-integrity-rules-and-trust-modes.md"
          },
          "trustMode": "human_only"
        },
        "links": {
          "results": {
            "href": "href",
            "method": "GET"
          }
        },
        "livemode": true,
        "organizationId": "organizationId",
        "projectId": "projectId",
        "source": {
          "id": "id",
          "type": "type"
        },
        "type": "tournament.completed"
      },
      "eventId": "eventId",
      "failedAt": "2024-08-25T15:00:00Z",
      "id": "id",
      "lastAttemptAt": "2024-08-25T15:00:00Z",
      "lastErrorCode": "lastErrorCode",
      "lastErrorMessage": "lastErrorMessage",
      "lastResponseSnippet": "lastResponseSnippet",
      "lastSecretVersionId": "lastSecretVersionId",
      "lastStatusCode": 0,
      "nextAttemptAt": "2024-08-25T15:00:00Z",
      "organizationId": "organizationId",
      "projectId": "projectId",
      "status": "pending",
      "succeededAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Replay webhook delivery

POST

https://api.pokerworks.io

/api/v1/management/webhook-deliveries/{deliveryId}/replay

Replay a webhook delivery using the current endpoint secret

Replay webhook delivery › path Parameters

deliveryId

string · required

Parameter deliveryId.

Replay webhook delivery › Responses

ReplayWebhookDeliveryResponse

object · required

POST/api/v1/management/webhook-deliveries/{deliveryId}/replay

curl https://api.pokerworks.io/api/v1/management/webhook-deliveries/:deliveryId/replay \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "webhookDelivery": {
    "attemptCount": 0,
    "attempts": [
      {
        "attemptNumber": 1,
        "completedAt": "2024-08-25T15:00:00Z",
        "errorCode": "errorCode",
        "errorMessage": "errorMessage",
        "id": "id",
        "latencyMs": 0,
        "responseSnippet": "responseSnippet",
        "secretVersionId": "secretVersionId",
        "startedAt": "2024-08-25T15:00:00Z",
        "status": "succeeded",
        "statusCode": 0
      }
    ],
    "createdAt": "2024-08-25T15:00:00Z",
    "endpointId": "endpointId",
    "endpointUrl": "https://www.example.com/path/to/resource",
    "environment": "test",
    "event": {
      "apiVersion": "apiVersion",
      "createdAt": "2024-08-25T15:00:00Z",
      "data": {
        "key": {}
      },
      "environment": "test",
      "id": "id",
      "integrity": {
        "botsAllowed": true,
        "declaredBotSeats": {
          "count": 0,
          "present": true
        },
        "supportEvidence": {
          "trustModePolicyRef": "docs/architecture/developer-integrity-rules-and-trust-modes.md"
        },
        "trustMode": "human_only"
      },
      "links": {
        "results": {
          "href": "href",
          "method": "GET"
        }
      },
      "livemode": true,
      "organizationId": "organizationId",
      "projectId": "projectId",
      "source": {
        "id": "id",
        "type": "type"
      },
      "type": "tournament.completed"
    },
    "eventId": "eventId",
    "failedAt": "2024-08-25T15:00:00Z",
    "id": "id",
    "lastAttemptAt": "2024-08-25T15:00:00Z",
    "lastErrorCode": "lastErrorCode",
    "lastErrorMessage": "lastErrorMessage",
    "lastResponseSnippet": "lastResponseSnippet",
    "lastSecretVersionId": "lastSecretVersionId",
    "lastStatusCode": 0,
    "nextAttemptAt": "2024-08-25T15:00:00Z",
    "organizationId": "organizationId",
    "projectId": "projectId",
    "status": "pending",
    "succeededAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Tournament results & verification Embeds

Create webhook endpoint

POST

https://api.pokerworks.io

/api/v1/management/webhook-endpoints

Create a reveal-once webhook endpoint signing secret

Create webhook endpoint › Request Body

CreateWebhookEndpointRequest

environment

string · enum · required

Enum values:

test

live

eventTypes

string[] · minItems: 1 · maxItems: 20 · required

Enum values:

tournament.completed

label

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

url

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

Create webhook endpoint › Responses

CreateWebhookEndpointResponse

object · required

Get webhook endpoint

GET

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}

Read a webhook endpoint visible to a management token

Get webhook endpoint › path Parameters

endpointId

string · required

Parameter endpointId.

Get webhook endpoint › Responses

GetWebhookEndpointResponse

object · required

Delete webhook endpoint

DELETE

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}

Delete a webhook endpoint without removing delivery evidence

Delete webhook endpoint › path Parameters

endpointId

string · required

Parameter endpointId.

Delete webhook endpoint › Responses

DeleteWebhookEndpointResponse

object · required

Update webhook endpoint

PATCH

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}

Update and verify a webhook endpoint

Update webhook endpoint › path Parameters

endpointId

string · required

Parameter endpointId.

Update webhook endpoint › Request Body

UpdateWebhookEndpointRequest

eventTypes

string[] · minItems: 1 · maxItems: 20

Enum values:

tournament.completed

label

string · minLength: 1 · maxLength: 120

status

string · enum

Enum values:

active

disabled

url

string · uri · minLength: 1 · maxLength: 2048

Update webhook endpoint › Responses

UpdateWebhookEndpointResponse

object · required

Rotate webhook endpoint secret

POST

https://api.pokerworks.io

/api/v1/management/webhook-endpoints/{endpointId}/rotate-secret

Rotate a webhook endpoint signing secret

Rotate webhook endpoint secret › path Parameters

endpointId

string · required

Parameter endpointId.

Rotate webhook endpoint secret › Responses

RotateWebhookEndpointSecretResponse

object · required

Replay webhook delivery

POST

https://api.pokerworks.io

/api/v1/management/webhook-deliveries/{deliveryId}/replay

Replay a webhook delivery using the current endpoint secret

Replay webhook delivery › path Parameters

deliveryId

string · required

Parameter deliveryId.

Replay webhook delivery › Responses

ReplayWebhookDeliveryResponse

object · required