POpolar-com
Webhooks

Update webhook

Changed on

Edit webhook event types and/or url.

When updating webhook url the AccessLink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.

patch/v3/webhooks/{webhook-id}

Request

Path parameters

webhook-idstring required

Webhook id to update

Request body

eventsWebhookType[]

Type of events to subscribe.

urlstring uri

Url where the webhook notification is sent.

Example request

{
  "events": [
    "EXERCISE"
  ],
  "url": "https://myapp.example.com/acl_webhook"
}

Response

Webhook updated successfully.

Example response

{
  "data": [
    {
      "id": "abdf33",
      "events": [
        "EXERCISE"
      ],
      "url": "https://myapp.example.com/acl_webhook",
      "active": true
    }
  ]
}

Changes

  • 18ce96365320Revision changes
    • breaking

      removed the enum value EXERCISE SLEEP CONTINUOUS_HEART_RATE SLEEP_WISE_CIRCADIAN_BEDTIME SLEEP_WISE_ALERTNESS ACTIVITY_SUMMARY of the request property /

    • warning

      added the new ACTIVITY_SUMMARY enum value to the /// response property for the response status

    • warning

      added the new CONTINUOUS_HEART_RATE enum value to the /// response property for the response status

    • warning

      added the new EXERCISE enum value to the /// response property for the response status

    • warning

      added the new PHYSICAL_INFORMATION enum value to the /// response property for the response status

    • warning

      added the new SLEEP enum value to the /// response property for the response status

    • warning

      added the new SLEEP_WISE_ALERTNESS enum value to the /// response property for the response status

    • warning

      added the new SLEEP_WISE_CIRCADIAN_BEDTIME enum value to the /// response property for the response status

    • info

      added the new ACTIVITY_SUMMARY enum value to the request property /

    • info

      added the new CONTINUOUS_HEART_RATE enum value to the request property /

    • info

      added the new EXERCISE enum value to the request property /

    • info

      added the new PHYSICAL_INFORMATION enum value to the request property /

    • info

      added the new SLEEP enum value to the request property /

    • info

      added the new SLEEP_WISE_ALERTNESS enum value to the request property /

    • info

      added the new SLEEP_WISE_CIRCADIAN_BEDTIME enum value to the request property /

    • info

      removed the EXERCISE SLEEP CONTINUOUS_HEART_RATE SLEEP_WISE_CIRCADIAN_BEDTIME SLEEP_WISE_ALERTNESS ACTIVITY_SUMMARY enum value from the /// response property for the response status

  • f197848bba31Revision changes
    • breaking

      removed the enum value EXERCISE SLEEP CONTINUOUS_HEART_RATE SLEEP_WISE_CIRCADIAN_BEDTIME SLEEP_WISE_ALERTNESS of the request property /

    • warning

      added the new EXERCISE SLEEP CONTINUOUS_HEART_RATE SLEEP_WISE_CIRCADIAN_BEDTIME SLEEP_WISE_ALERTNESS ACTIVITY_SUMMARY enum value to the /// response property for the response status

    • info

      added the new EXERCISE SLEEP CONTINUOUS_HEART_RATE SLEEP_WISE_CIRCADIAN_BEDTIME SLEEP_WISE_ALERTNESS ACTIVITY_SUMMARY enum value to the request property /

    • info

      removed the EXERCISE SLEEP CONTINUOUS_HEART_RATE SLEEP_WISE_CIRCADIAN_BEDTIME SLEEP_WISE_ALERTNESS enum value from the /// response property for the response status