CreateWebhookDto

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

discord_colorstringOptional

discord_description_templatestringOptional

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

Example

{
  "subscribed_to": "OnIgnore",
  "type": "JsonV1",
  "url": "string",
  "discord_color": "string",
  "discord_description_template": "string",
  "discord_format": "Invalid",
  "discord_title": "string"
}