PayNow

WebhookSubscriptionDto

Represents a webhook subscription: an endpoint that receives a request whenever one of the subscribed events happens in the store.

idFlakeIdRequired
secretstringRequired
The secret used to sign each delivery. Receivers use it to verify the request's signature header and confirm it came from PayNow.
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
  • OnChargebackLifecycle
typeenumRequired
Specifies the payload format a webhook delivers.
Possible enum values
  • JsonV1

    The event is posted as JSON. This is the default.

  • DiscordV1

    The event is posted as a Discord message.

urlstringRequired
The URL each event is delivered to. For the 'DiscordV1' type this is the Discord webhook URL.
discord_colorstringOptional
The accent colour of the Discord embed, as a hex colour. Only used by the 'DiscordV1' type with the 'Embed' format.
discord_description_templatestringOptional
The template rendered into the body of the Discord message, with webhook variables substituted. Only used by the 'DiscordV1' type.
discord_formatenumOptional
Specifies how a Discord webhook renders its message.
Possible enum values
  • Invalid

    No format specified. This value is typically used as a default or uninitialized state.

  • Embed

    The message is sent as a rich embed with the configured title, colour and description.

  • Text

    The message is sent as plain text rendered from the description template.

discord_titlestringOptional
The title of the Discord embed. Only used by the 'DiscordV1' type with the 'Embed' format.
Example
{
  "id": "411486491630370816",
  "secret": "string",
  "subscribed_to": "OnIgnore",
  "type": "JsonV1",
  "url": "string",
  "discord_color": "string",
  "discord_description_template": "string",
  "discord_format": "Invalid",
  "discord_title": "string"
}