Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Notification

Update webhook subscription

Update webhook subscription by ID.

put/subscriptions/webhook/{id}

Path parameters

idinteger required

The webhook subscription ID

Request body

applicationstring required

The external application name.

urlstring required

The webhook endpoint URL.

secretstring

The basic auth secret for the webhook endpoint.

message_type'LOCATION_AP_CENTRIC' | 'LOCATION_CLIENT_CENTRIC' | 'AUDIT_LOG_ALL' | 'GDPR_LOG_ALL' | 'CREDENTIAL_LOG_ALL' | 'ACCOUNTING_LOG_ALL' | 'AUTHENTICATION_LOG_ALL' | 'EMAIL_LOG_ALL' | 'SMS_LOG_ALL' required

The subscription message type.

status'ENABLED' | 'DISABLED' required

The webhook subscription status.

Example request

{
  "application": "example-app",
  "url": "https://webhook_endpoint-example-123",
  "secret": "erw3245cq3dasbjtyj",
  "message_type": "LOCATION_AP_CENTRIC"
}

Response

OK

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

applicationstring required

The external application name.

urlstring required

The webhook endpoint URL.

secretstring required

The basic auth secret for the webhook endpoint.

data_type'LOCATION' | 'AUDIT_LOG' | 'GDPR_LOG' | 'CREDENTIAL_LOG' | 'ACCOUNTING_LOG' | 'AUTHENTICATION_LOG' | 'EMAIL_LOG' | 'SMS_LOG' required

The webhook subscription data type.

message_type'LOCATION_AP_CENTRIC' | 'LOCATION_CLIENT_CENTRIC' | 'AUDIT_LOG_ALL' | 'GDPR_LOG_ALL' | 'CREDENTIAL_LOG_ALL' | 'ACCOUNTING_LOG_ALL' | 'AUTHENTICATION_LOG_ALL' | 'EMAIL_LOG_ALL' | 'SMS_LOG_ALL' required

The subscription message type.

status'ENABLED' | 'DISABLED' required

The webhook subscription status.

Example response

{
  "message_type": "LOCATION_AP_CENTRIC"
}