Webhooks

Update notification setting

Authentication methods provided for secure communication of webhooks are given below. For each URL, value of authentication type must be passed.

Authentication Type	Value	Description
No Authentication	none	Webhooks are accessible without any authentication requirements. RequiredParameters: authenticationType
Basic Authentication	basic	Users must include a username and password with each webhook which is encoded and sent with request. RequiredParameters: authenticationType, userName, password
Bearer Token Authentication	oauth	In this method, token generated by the server are included in request headers. RequiredParameters: authenticationType, clientId, clientSecret

patch/orgunit/{orgunitId}/groups/{groupId}/notification-url

Request

Base URL
https://api-docs.ministrybytext.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/ministrybytext/apis/pbt-api-documentation/docs/orgunit/:orgunitId/groups/:groupId/notification-url/patch.ts
A function with typed inputs. Its response is checked against the schema.

orgunitIdstring required

orgunitId

groupIdstring required

groupId

callbackUrlEnabledboolean

statusUrlEnabledboolean

personalUrlEnabledboolean

Success

appCodestring

messagestring

isErrorboolean

No recorded changes to this operation across all 5 revisions of this API.