Skip to main content
POST
/
webhooks
Create a webhook endpoint
curl --request POST \
  --url https://api.sellfern.com/webhooks \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "order.created",
      "order.status_changed"
    ],
    "enabled": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Sellfern public API key scoped to the authenticated organization. Do not use user JWTs for public integrations.

Headers

​
Idempotency-Key
string
required

Required for public write retries. Reuse the same key for safe retry after network or 5xx uncertainty. Reusing a key with a different request returns 422 idempotency_conflict.

Required string length: 1 - 255

Body

application/json
​
url
string<uri>
​
events
string[]
​
enabled
boolean

Response

Mutation completed successfully.

​
success
boolean
required
Example:

true

​
data
object
required
​
meta
object