Customer one-time-password requestedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Customer webhook request body resource.

customerId
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

eventType
string (GlobalWebhookEventType)

Rebilly webhooks event type.

Enum: "aml-list-possibly-matched" "application-instance-disabled" "application-instance-disabled" "application-instance-enabled" "application-instance-enabled" "balance-transaction-settled" "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" … 76 more
object
object (Customer)
id
string <= 50 characters

The customer identifier string.

email
string <email>

The customer's email.

firstName
string

The customer's first name.

lastName
string

The customer's last name.

websiteId
string <= 50 characters

The website's ID.

Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrumentValueObject)
createdTime
string <date-time>

The customer created time.

updatedTime
string <date-time>

Read-only timestamp updates when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (ContactObject)
object (CustomerAverageValue)
paymentCount
integer

The number of approved payments for the customer.

lastPaymentTime
string <date-time>

The most recent time of an approved payment for the customer.

object (CustomerLifetimeRevenue)
invoiceCount
integer

An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer.

Array of objects (Tag)

A list of customer's tags.

revision
integer

The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

isEddRequired
boolean
Default: false

Indicates if EDD is enabled for this customer.

hasFulfilledKyc
boolean

Specifies whether the customer has accepted and reviewed identity and address documents, or an accepted credit file document.

Array of Self (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items

The links related to resource.

Array of LeadSourceEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Array of CustomerLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
rel
required
string

The link type.

Enum: "customer" "targetCustomer"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}