Skip to main content
PUT
/
webhook
Configure partner webhook
curl --request PUT \
  --url 'https://partner-api.ochy-prod.com/webhook?apiKey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://client.example.com/webhooks/ochy",
  "enabled": true
}
'
{
  "url": "https://client.example.com/webhooks/ochy",
  "enabled": true,
  "updated_at": "2026-03-23T10:45:00Z"
}

Authorizations

​
apiKey
string
query
required

Your API key, passed as a query parameter on every request.

Body

application/json
​
url
string<uri>
required

HTTPS endpoint that will receive POST requests with JSON payloads.

Example:

"https://client.example.com/webhooks/ochy"

​
enabled
boolean
required

When false, no webhook events are sent until set back to true.

Example:

true

Response

Webhook configuration saved. Body mirrors GET /webhook.

Returned by GET /webhook and PUT /webhook. When no webhook has been stored yet, GET /webhook returns an empty object.

​
url
string<uri>

Registered webhook URL.

Example:

"https://client.example.com/webhooks/ochy"

​
enabled
boolean

Whether webhook delivery is enabled for this partner.

Example:

true

​
updated_at
string<date-time>

When the configuration was last updated (ISO 8601 UTC).

Example:

"2026-03-23T10:45:00Z"