Get Webhook Subscription

GET

/v2/webhook/subscription/{id}

Code sample: cURL

curl --location --request GET 'https://api.ouraring.com/v2/webhook/subscription/5d3fe17b-f880-4d93-b9b6-afbfb76c1e78' --header 'x-client-id: client-id' --header 'x-client-secret: client-secret'

• Oura API

Authorizations

• ClientIdAuth
• ClientSecretAuth

Parameters

Path Parameters

id

required

Id

string

Responses

200

Successful Response

Media typeapplication/json

WebhookSubscriptionModel

object

id

required

Id

string format: uuid4

callback_url

required

Callback Url

string

event_type

required

WebhookOperation

string

Allowed values: create update delete

data_type

required

ExtApiV2DataType

string

Allowed values: tag enhanced_tag workout session sleep daily_sleep daily_readiness daily_activity daily_spo2 sleep_time rest_mode_period ring_configuration daily_stress daily_cardiovascular_age daily_resilience vo2_max meal

expiration_time

required

Expiration Time

string format: date-time

Example

{
  "event_type": "create",
  "data_type": "tag"
}

403

Webhook with specified id does not exist.

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}