Update Third Party Settings

PATCH

settings

third-party

Update third party settings.

curl --request PATCH \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/settings/third-party \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhooks_enabled": true,
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "email_landing_url": "<string>"
}
'

{
  "data": {
    "webhooks_enabled": true,
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "email_landing_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Third party configuration settings.

webhooks_enabled

boolean

webhook_url

string | null

URL for webhook. Must be https.

webhook_secret

string | null

Secret to sign webhook calls.

email_landing_url

string | null

URL used in email notifications to direct user to specific page.

Response

200 - application/json

Success

data

object

Third party configuration settings.

Show child attributes

CRMGet currently active CRM settings.

Update third party settings.

curl --request PATCH \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/settings/third-party \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhooks_enabled": true,
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "email_landing_url": "<string>"
}
'

{
  "data": {
    "webhooks_enabled": true,
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "email_landing_url": "<string>"
  }
}