Metriport home pagelight logo
  1. Settings
  2. Update Settings
POST

/settings

x-api-key*
curl --request POST \
     --url https://api.metriport.com/settings \
     --header 'x-api-key: AUTH_VALUE' \
     --header 'Content-Type: application/json' \
     --data '{
 "webhookUrl": "string"
}'

​
Body

webhookUrlRequired
string

The webhook URL to be stored with your settings. It should be a valid URL.

​
Response

idRequired
string

The settings ID.

webhookUrlRequired
string

Your application’s webhook URL.

webhookKeyRequired
string

The key used to authenticate webhook calls to your app.

import { Metriport } from "@metriport/api";

const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");

const response = await metriportClient.updateSettings("https://api.health.com/webhook");

Example response:

{
  "id": "<settings-id>",
  "webhookUrl": "https://server.domain.com/webhook/endpoint",
  "webhookKey": "<webhook-key>"
}