Settings
Update Settings
Updates your account's settings.
POST
/
settings
Authorization
Body
curl --request POST \
--url https://api.sandbox.metriport.com/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{
"webhookUrl": "<string>"
}'
import { MetriportDevicesApi } from "@metriport/api-sdk";
const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");
const response = await metriportClient.updateSettings("https://api.health.com/webhook");
Body
webhookUrl
string
requiredThe webhook URL to be stored with your settings. It should be a valid URL.
For requirements for this URL, see our Webhooks guide.
Response
id
string
requiredThe settings ID.
webhookUrl
string
requiredYour application’s webhook URL.
webhookKey
string
requiredThe key used to authenticate webhook calls to your app.
Example response:
{
"id": "<settings-id>",
"webhookUrl": "https://server.domain.com/webhook/endpoint",
"webhookKey": "<webhook-key>"
}
curl --request POST \
--url https://api.sandbox.metriport.com/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{
"webhookUrl": "<string>"
}'
import { MetriportDevicesApi } from "@metriport/api-sdk";
const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");
const response = await metriportClient.updateSettings("https://api.health.com/webhook");