Skip to content
Linra Omni Developer Docs

Update a webhook subscription's URL and/or subscribed event types

PUT
/api/v1/webhooks/{id}
curl --request PUT \
  --url https://api-omni.linra.net/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "eventTypes": [ "order.completed" ] }'

If the URL changes, it is re-validated against the same SSRF guard applied at creation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
url
string format: uri
nullable
eventTypes
Array<string>
nullable
Allowed values: order.completed order.failed order.cancelled order.returned order.fulfilment-updated variant.back-in-stock order.return-request.updated

Responses

Section titled “Responses”

200

Section titled “200”

The updated subscription.

Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required
object
id
string format: uuid
partnerId
string format: uuid
url
string format: uri
eventTypes
Array<string>
isActive
boolean
lastDeliveryAt
string format: date-time
nullable
lastDeliveryStatus
string
nullable
createdAt
string format: date-time
nullable
Example
{
  "state": "SUCCESS"
}

400

Section titled “400”

Request validation failed.

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Example
{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

404

Section titled “404”

Unknown subscription.

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Example
{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

429

Section titled “429”

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Example
{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.