Webhook endpoints

Endpoints

POST/v1/webhook_endpoints
PATCH/v1/webhook_endpoints/{endpoint}
GET/v1/webhook_endpoints/{endpoint}
GET/v1/webhook_endpoints
DELETE/v1/webhook_endpoints/{endpoint}

The Webhook endpoint object

Attributes

idstring
Unique identifier of the object (prefixed, opaque).
objectstring
webhook_endpoint
urlstring
descriptionstringnullable
enabled_eventsarray of string
brandsarray of objectnullable
statusenum
Possible values: enabled · disabled
api_versionstring
livemodeboolean
true for live data, false for the test-mode sandbox.
createdinteger
Time at which the object was created (unix timestamp, seconds).
secretstring

The Webhook endpoint object


{
  "id": "we_034eTM6NVwPXgyvF595hZZ",
  "object": "webhook_endpoint",
  "url": "https://hooks.example.com/skoup",
  "description": "Rewrite the product copy so the frame warranty is stated.",
  "enabled_events": [
    "string"
  ],
  "brands": [
    {}
  ],
  "status": "enabled",
  "api_version": "v1",
  "livemode": true,
  "created": 1790000000,
  "secret": "whsec_9fW2kLq7Rt4mXz1Vb8Nc3Hy6"
}

Create a webhook endpoint

POST/v1/webhook_endpoints

The response carries the signing secret (whsec_…) — the only time the API returns it. Store it to verify the X-Skoup-Signature header.

Parameters

urlstringrequired
descriptionstringnullable
enabled_eventsarray of stringrequired
brandsarray of stringnullable
disabledboolean

Returns

Returns the created webhook_endpoint object. Raises an error if something goes wrong.

curl


curl -X POST https://api.skoup.ai/v1/webhook_endpoints \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://nordvelo.fr","enabled_events":["string"],"description":"Rewrite the product copy so the frame warranty is stated."}'

Node.js


const response = await fetch('https://api.skoup.ai/v1/webhook_endpoints', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"url":"https://nordvelo.fr","enabled_events":["string"],"description":"Rewrite the product copy so the frame warranty is stated."}),
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('POST', 'webhook_endpoints', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
    'json' => ['url' => 'https://nordvelo.fr', 'enabled_events' => ['string'], 'description' => 'Rewrite the product copy so the frame warranty is stated.'],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.post(
    "https://api.skoup.ai/v1/webhook_endpoints",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
    json={"url": "https://nordvelo.fr", "enabled_events": ["string"], "description": "Rewrite the product copy so the frame warranty is stated."},
)
data = response.json()

Response


{
  "id": "we_034eTM6NVwPXgyvF595hZZ",
  "object": "webhook_endpoint",
  "url": "https://hooks.example.com/skoup",
  "description": "Rewrite the product copy so the frame warranty is stated.",
  "enabled_events": [
    "string"
  ],
  "brands": [
    {}
  ],
  "status": "enabled",
  "api_version": "v1",
  "livemode": true,
  "created": 1790000000,
  "secret": "whsec_9fW2kLq7Rt4mXz1Vb8Nc3Hy6"
}

Update a webhook endpoint

PATCH/v1/webhook_endpoints/{endpoint}

Send disabled: true to pause it, false to enable it again.

Parameters

endpointstringrequired
Webhook Endpoint id (we_…).
urlstringrequired
descriptionstringnullable
enabled_eventsarray of stringrequired
brandsarray of stringnullable
disabledboolean

Returns

Returns the updated webhook_endpoint object. Raises an error if something goes wrong.

curl


curl -X PATCH https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://nordvelo.fr","enabled_events":["string"],"description":"Rewrite the product copy so the frame warranty is stated."}'

Node.js


const response = await fetch('https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"url":"https://nordvelo.fr","enabled_events":["string"],"description":"Rewrite the product copy so the frame warranty is stated."}),
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('PATCH', 'webhook_endpoints/we_034ebikiyFV76y9oiMvhxm', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
    'json' => ['url' => 'https://nordvelo.fr', 'enabled_events' => ['string'], 'description' => 'Rewrite the product copy so the frame warranty is stated.'],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.patch(
    "https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
    json={"url": "https://nordvelo.fr", "enabled_events": ["string"], "description": "Rewrite the product copy so the frame warranty is stated."},
)
data = response.json()

Response


{
  "id": "we_034eTM6NVwPXgyvF595hZZ",
  "object": "webhook_endpoint",
  "url": "https://hooks.example.com/skoup",
  "description": "Rewrite the product copy so the frame warranty is stated.",
  "enabled_events": [
    "string"
  ],
  "brands": [
    {}
  ],
  "status": "enabled",
  "api_version": "v1",
  "livemode": true,
  "created": 1790000000,
  "secret": "whsec_9fW2kLq7Rt4mXz1Vb8Nc3Hy6"
}

Retrieve a webhook endpoint

GET/v1/webhook_endpoints/{endpoint}

Parameters

endpointstringrequired
Webhook Endpoint id (we_…).

Returns

Returns the webhook_endpoint object. Raises an error if something goes wrong.

curl


curl https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
  },
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('GET', 'webhook_endpoints/we_034ebikiyFV76y9oiMvhxm', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.get(
    "https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Response


{
  "id": "we_034eTM6NVwPXgyvF595hZZ",
  "object": "webhook_endpoint",
  "url": "https://hooks.example.com/skoup",
  "description": "Rewrite the product copy so the frame warranty is stated.",
  "enabled_events": [
    "string"
  ],
  "brands": [
    {}
  ],
  "status": "enabled",
  "api_version": "v1",
  "livemode": true,
  "created": 1790000000,
  "secret": "whsec_9fW2kLq7Rt4mXz1Vb8Nc3Hy6"
}

List webhook endpoints

GET/v1/webhook_endpoints

Parameters

limitinteger
Number of objects to return, between 1 and 100 (default 20).
starting_afterstring
Cursor: the id of the last object of the previous page.

Returns

A dictionary with a data property holding up to limit webhook_endpoint objects, newest first, and has_more telling whether another page exists. Raises an error if something goes wrong.

curl


curl https://api.skoup.ai/v1/webhook_endpoints?limit=3 \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/webhook_endpoints?limit=3', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
  },
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('GET', 'webhook_endpoints?limit=3', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.get(
    "https://api.skoup.ai/v1/webhook_endpoints?limit=3",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Response


{
  "object": "list",
  "url": "/v1/webhook_endpoints",
  "has_more": false,
  "data": [
    {
      "id": "we_034eTM6NVwPXgyvF595hZZ",
      "object": "webhook_endpoint",
      "url": "https://hooks.example.com/skoup",
      "description": "Rewrite the product copy so the frame warranty is stated.",
      "enabled_events": [
        "string"
      ],
      "brands": [
        {}
      ],
      "status": "enabled",
      "api_version": "v1",
      "livemode": true,
      "created": 1790000000,
      "secret": "whsec_9fW2kLq7Rt4mXz1Vb8Nc3Hy6"
    }
  ]
}

Delete a webhook endpoint

DELETE/v1/webhook_endpoints/{endpoint}

Parameters

endpointstringrequired
Webhook Endpoint id (we_…).

Returns

Returns an object with deleted: true. Raises an error if something goes wrong.

curl


curl -X DELETE https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
  },
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('DELETE', 'webhook_endpoints/we_034ebikiyFV76y9oiMvhxm', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.delete(
    "https://api.skoup.ai/v1/webhook_endpoints/we_034ebikiyFV76y9oiMvhxm",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Response


{
  "id": "we_034ebikiyFV76y9oiMvhxm",
  "object": "webhook_endpoint",
  "deleted": true
}