new Webhook()
Creates a new Webhook. Generally you should never create a PAYMILL object on your own.
- Source:
Extends
- PaymillObject
Classes
Members
-
<static> EventType
-
An event type for a webhook.
- Source:
Properties:
Name Type Description CHARGEBACK_EXECUTED
string returns a transaction-object with state set to chargeback TRANSACTION_CREATED
string returns a transaction-object TRANSACTION_SUCCEDED
string returns a transaction-object TRANSACTION_FAILED
string returns a transaction-object SUBSCRIPTION_CREATED
string returns a subscription-object SUBSCRIPTION_UPDATED
string returns a subscription-object SUBSCRIPTION_DELETED
string returns a subscription-object SUBSCRIPTION_SUCCEEDED
string returns a subscription-object SUBSCRIPTION_FAILED
string returns a subscription-object REFUND_CREATED
string returns a refund-object REFUND_SUCCEEDED
string returns a refund-object REFUND_FAILED
string returns a refund-object PAYOUT_TRANSFERRED
string returns an invoice-object with the payout sum for the invoice period INVOICE_AVAILABLE
string returns an invoice-object with the fees sum for the invoice period APP_MERCHANT_ACTIVATED
string returns a merchant-object if a connected merchant was activated APP_MERCHANT_DEACTIVATED
string returns a merchant-object if a connected merchant was deactivated APP_MERCHANT_REJECTED
string returns a merchant-object if a connected merchant was rejected -
app_id :string
-
App (ID) that created this webhook or null if created by yourself.
Type:
- string
- Source:
-
email :string
-
The email of the webhook. Either the email OR the url have to be set and will be returned
Type:
- string
- Source:
-
event_types :Array.<Webhook.EventType>
-
Event types.
Type:
- Array.<Webhook.EventType>
- Source:
-
id :string
-
Unique identifier of this webhook
Type:
- string
- Source:
-
livemode :boolean
-
you can create webhooks for livemode and testmode.
Type:
- boolean
- Source:
-
url :string
-
The url of the webhook. Either the email OR the url have to be set and will be returned
Type:
- string
- Source: