OpenSkin API endpoint
Create a webhook endpoint
POST /v2/webhooks
Creates a webhook endpoint and returns its signing secret with the initial response.
Authentication
Send a Platform API key with permission to use this endpoint in the X-API-Key header.
Parameters
| Name | Location | Required | Description |
|---|---|---|---|
Idempotency-Key | header | Yes | See the OpenAPI schema for accepted values. |
Request body
The example includes every required JSON field. Open OpenAPI JSON to see optional fields, accepted values, and limits.
Response meaning
201- Endpoint and one-time signing secret
401- V2Unauthorized
403- V2Forbidden
409- Idempotency key reused with different content
503- encrypted webhook-secret storage is not configured
Request example
curl 'https://api-v2.openskin.dev/v2/webhooks'\
-X POST\
-H 'X-API-Key: osk_live_...' \
-H 'Idempotency-Key: example-Idempotency-Key' \
-H 'Content-Type: application/json' \
--data '{"url":"https://example.com/openskin-events","event_types":["price.updated"]}'Limits and retries
Check the listed status codes before retrying. If a request uses a unique request key, reuse that key only when repeating the same request. If a list returns next_cursor, send it unchanged in the next request.
Last updated .