Skip to main content
POST
/
webhooks
Create a new Webhook
curl --request POST \
  --url https://commerce.driv.ly/api/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "url": "<string>",
  "tenants": [
    123
  ],
  "method": "<string>"
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "url": "<string>",
    "tenants": [
      123
    ],
    "method": "<string>"
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { webhooks } from '@drivly/commerce'

const sdk = new SDK(...)

const webhooks = await sdk.webhooks.create(data: webhooks): Promise<webhooks>

Authorizations

​
Authorization
string
header
required

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
url
string | null
​
tenants
(number | Tenant · object)[] | null
​
method
string | null

Response

200 - application/json

ok

​
doc
Webhook · object
required
​
message
string
required