{
    "id": null,
    "name": "My Ecommerce Webhook",
    "url": null,
    "isActive": null,
    "apiVersion": null,
    "events": [],
    "alertEmails": [],
    "verificationMethod": {
        "hmac256": {
            "secret": null
        }
    },
    "customHeaders": null,
    "createTime": null,
    "metadata": null
}

{
    "id": null,
    "name": "My Ecommerce Webhook",
    "url": null,
    "isActive": null,
    "apiVersion": null,
    "events": [],
    "alertEmails": [],
    "verificationMethod": {
        "hmac256": {
            "secret": null
        }
    },
    "customHeaders": null,
    "createTime": null,
    "metadata": null
}
​
📋
Properties
​
id
string

The unique identifier for the webhook object

​
name
string

The name of the webhook.

MinLength: 1

MaxLength: 100

Example: My Ecommerce Webhook

​
url
string

The URL where the webhook events are sent.

​
isActive
boolean

Denotes whether the webhook is active.

​
apiVersion
string

The API version the webhook supports.

​
events
array

The list of events that triggers the webhook.

​
alertEmails
array

The list email address to send alert notifications to when the webhook is failing.

​
verificationMethod
object

The verification method of the webhook.

​
customHeaders
object

Custom headers of the webhook.

​
createTime
string

The creation time of the webhook.

​
metadata
object

This holds key-value pairs, where both the keys and values are strings not exceeding 64 and 100 characters respectively. This allows for flexible and descriptive tagging or additional information to be associated with the object.

Was this page helpful?

Suggest editsRaise issue