Skip to main content
PUT
Update Webhook Config

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Update webhook configuration for a tenant.

webhookUrl
string | null
webhookEnabled
boolean
default:false
webhookSubscriptions
string[]

Response

Successful Response

The configuration for each of the clients of Decoda.

name
string
required
subDomain
string
required
providerDeactivatedPages
string[]
required
patientDeactivatedPages
string[]
required
enabledModules
enum<string>[]
required
Available options:
TEXTING,
CALLING,
PAYMENTS,
SCRIBE,
SCHEDULING,
FORMS,
INVENTORY,
LOCATIONS,
CALENDAR_PATIENT_STATUS,
SPAKINECT,
SCRIBE_MEDICAL_CODES
homePage
string
required
passFeeToPatient
boolean
required
paymentProcessor
string
required
activatedChargeMethods
string[]
required
phoneNumber
string
required
logoUrl
string
required
successfulPaymentText
string
required
campaign
string
required
enterpriseTenant
string | null
required
manualInvoiceText
string
required
sendReceiptText
string
required
smsProvider
enum<string>
required
Available options:
SIGNALWIRE,
SENDO
clinicType
enum<string>
default:DEFAULT
Available options:
DEFAULT,
WEIGHT_LOSS,
MED_SPA
practiceTypeCode
integer | null
slogan
string | null
replyToEmail
string | null
ccEmail
string | null
defaultTimezone
string | null
hidePatientPaymentPlans
boolean
default:false
coloredMail
boolean
default:false
requiredPatientFields
string[]
enabledCommunicationMethods
enum<string>[]
Available options:
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
enabledInvoiceMethods
enum<string>[]

The method used to send an invoice to a patient.

Available options:
CHARGE_CARD,
SMS,
EMAIL,
CALL,
MAIL,
EXPIRY
maxInvoicesPerDay
integer
default:100
invoicingStartTime
integer
default:9
invoicingEndTime
integer
default:17
invoicingOnWeekends
boolean
default:false
invoicingExcludesHolidays
boolean
default:false
maxInvoicesPerMinute
integer
default:10
autoRespondToSms
boolean
default:false
generateResponseOnSms
boolean
default:false
billAutomatically
boolean
default:false
selfSchedulingRedirectUrl
string | null
allowMultipleBookingsForDifferentAppointments
boolean
default:false
allowMultipleSelfScheduleAppointments
boolean
default:false
daysUntilPatientBecomesNew
integer | null
authTimeoutMs
integer | null
introductoryText
string | null
optOutMessage
string | null
helpMessage
string | null
apiKey
string | null
gcalEmail
string | null
gcalToken
string | null
gcalRefreshToken
string | null
auditSmsResponse
boolean
default:false
itemSortType
enum<string>
default:USAGE
Available options:
CATEGORY,
USAGE,
DEFINED_ORDER,
NAME,
PRICE
reservationCancellationSmsTemplate
string | null
automaticallySendReceipts
boolean
default:true
defaultReceiptCommunicationMethod
enum<string>
default:SMS
Available options:
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
receiptLogoUrl
string | null
duplicatePatientFields
string[]
googleTagManagerId
string | null