Webhooks

Get Subscriptions

GEThttps://api.paynow.gg/v1/stores/{storeId}/webhooks

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

200OKWebhookSubscriptionDto[]

Show fields

idFlakeIdRequired

secretstringRequired

subscribed_toenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

typeenumRequired

Possible enum values

json_v1
discord_v1

urlstringRequired

discord_colorstringOptional

discord_description_templatestringOptional

discord_formatenumOptional

Possible enum values

Invalid
Embed
Text

discord_titlestringOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/webhooks" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.webhooks.getSubscriptions();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/webhooks", headers=headers)

Response200

[
  {
    "id": "411486491630370816",
    "secret": "string",
    "subscribed_to": "OnIgnore",
    "type": "json_v1",
    "url": "string",
    "discord_description_template": "string",
    "discord_title": "string",
    "discord_color": "string",
    "discord_format": "Invalid"
  }
]

Create Subscription

POSThttps://api.paynow.gg/v1/stores/{storeId}/webhooks

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

subscribed_toenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

typeenumRequired

Possible enum values

json_v1
discord_v1

urlstringRequired

discord_colorstringOptional

discord_description_templatestringOptional

discord_formatenumOptional

Possible enum values

Invalid
Embed
Text

discord_titlestringOptional

Response

200OKWebhookSubscriptionDto

Show fields

idFlakeIdRequired

secretstringRequired

subscribed_toenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

typeenumRequired

Possible enum values

json_v1
discord_v1

urlstringRequired

discord_colorstringOptional

discord_description_templatestringOptional

discord_formatenumOptional

Possible enum values

Invalid
Embed
Text

discord_titlestringOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/webhooks" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "subscribed_to": "OnIgnore",
  "type": "json_v1",
  "url": "string",
  "discord_description_template": "string",
  "discord_title": "string",
  "discord_color": "string",
  "discord_format": "Invalid"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.webhooks.createSubscription({
  subscribed_to: "OnIgnore",
  type: "json_v1",
  url: "string",
  discord_description_template: "string",
  discord_title: "string",
  discord_color: "string",
  discord_format: "Invalid",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "subscribed_to": "OnIgnore",
    "type": "json_v1",
    "url": "string",
    "discord_description_template": "string",
    "discord_title": "string",
    "discord_color": "string",
    "discord_format": "Invalid",
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/webhooks", headers=headers, json=payload)

Response200

{
  "id": "411486491630370816",
  "secret": "string",
  "subscribed_to": "OnIgnore",
  "type": "json_v1",
  "url": "string",
  "discord_description_template": "string",
  "discord_title": "string",
  "discord_color": "string",
  "discord_format": "Invalid"
}

Get Variables

GEThttps://api.paynow.gg/v1/stores/{storeId}/webhooks/variables

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

200OKWebhookVariablesDto[]

Show fields

event_typeenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

variablesstring[]Required

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/webhooks/variables" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.webhooks.getVariables();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/webhooks/variables", headers=headers)

Response200

[
  {
    "event_type": "OnIgnore",
    "variables": [
      "string"
    ]
  }
]

Update Subscription

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

webhookIdFlakeIdRequired

Request body

reset_secretbooleanRequired

subscribed_toenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

urlstringRequired

discord_colorstringOptional

discord_description_templatestringOptional

discord_formatenumOptional

Possible enum values

Invalid
Embed
Text

discord_titlestringOptional

Response

200OKWebhookSubscriptionDto

Show fields

idFlakeIdRequired

secretstringRequired

subscribed_toenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

typeenumRequired

Possible enum values

json_v1
discord_v1

urlstringRequired

discord_colorstringOptional

discord_description_templatestringOptional

discord_formatenumOptional

Possible enum values

Invalid
Embed
Text

discord_titlestringOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reset_secret": true,
  "subscribed_to": "OnIgnore",
  "url": "string",
  "discord_description_template": "string",
  "discord_title": "string",
  "discord_color": "string",
  "discord_format": "Invalid"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.webhooks.updateSubscription("411486491630370816", {
  reset_secret: true,
  subscribed_to: "OnIgnore",
  url: "string",
  discord_description_template: "string",
  discord_title: "string",
  discord_color: "string",
  discord_format: "Invalid",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "reset_secret": True,
    "subscribed_to": "OnIgnore",
    "url": "string",
    "discord_description_template": "string",
    "discord_title": "string",
    "discord_color": "string",
    "discord_format": "Invalid",
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}", headers=headers, json=payload)

Response200

{
  "id": "411486491630370816",
  "secret": "string",
  "subscribed_to": "OnIgnore",
  "type": "json_v1",
  "url": "string",
  "discord_description_template": "string",
  "discord_title": "string",
  "discord_color": "string",
  "discord_format": "Invalid"
}

Delete Subscription

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

webhookIdFlakeIdRequired

Response

204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.webhooks.deleteSubscription("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}", headers=headers)

Resend

POSThttps://api.paynow.gg/v1/stores/{storeId}/webhooks/resend

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

webhook_idFlakeIdRequired

Response

204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/webhooks/resend" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "webhook_id": "411486491630370816"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.webhooks.resend({
  webhook_id: "411486491630370816",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "webhook_id": "411486491630370816",
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/webhooks/resend", headers=headers, json=payload)

Get History

GEThttps://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}/history

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

webhookIdFlakeIdRequired

Query parameters

pageintegerOptional

statestringOptional

Response

200OKWebhookHistoryDto

Show fields

historyQueuedWebhookDto[]Required

created_atstringRequired

eventenumRequired

Possible enum values

OnIgnore
OnOrderCompleted
OnRefund
OnChargeback
OnDeliveryItemAdded
OnDeliveryItemActivated
OnDeliveryItemUsed
OnDeliveryItemRevoked
OnSubscriptionActivated
OnSubscriptionRenewed
OnSubscriptionCanceled
OnDiscordOrderActionsQueued
OnConnectedUserRegistered
OnConnectedUserBecamePayable
OnConnectedUserPayoutCreated
OnConnectedUserPayoutCompleted
OnConnectedUserTransactionInserted
OnConnectedUserBecameUnpayable
OnTrialActivated
OnTrialCompleted
OnTrialCanceled
OnPurchaseFollowUpAttemptEmailSent
OnPurchaseFollowUpAttemptSucceeded
OnAbandonedCheckoutRecoveryAttemptEmailSent
OnAbandonedCheckoutRecoveryAttemptSucceeded
OnChargebackClosed
OnDeliveryItemExpired
OnDeliveryItemRenewed
OnConnectedUserTrustStatusChanged
OnPaymentCompleted
OnPaymentFailed

executionsExecutedWebhookDto[]Required

idFlakeIdRequired

started_atstringRequired

status_codeintegerRequired

finished_atstringOptional

responsestringOptional

idFlakeIdRequired

payloadobjectRequired

stateenumRequired

Possible enum values

success
pending
failed
all

webhook_idFlakeIdRequired

next_retrystringOptional

pageintegerRequired

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}/history" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.webhooks.getHistory("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/webhooks/{webhookId}/history", headers=headers)

Response200

{
  "history": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "event": "OnIgnore",
      "executions": [
        {
          "id": "411486491630370816",
          "started_at": "2024-01-01T00:00:00Z",
          "status_code": 0,
          "finished_at": "2024-01-01T00:00:00Z",
          "response": "string"
        }
      ],
      "id": "411486491630370816",
      "payload": {},
      "state": "success",
      "webhook_id": "411486491630370816",
      "next_retry": "2024-01-01T00:00:00Z"
    }
  ],
  "page": 0
}