Webhook Integrations Webservice

Update webhook integration V2

Update preexisting webhooks

post/api/integrations/webhooks/updateWebhookIntegrationV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/integrations/webhooks/updateWebhookIntegrationV2
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

disabledboolean nullable

Whether the webhook is disabled

isDiagnosticboolean nullable

Whether this is a diagnostic webhook

webhookUrlstring nullable

Webhook URL for receiving notifications

Example request

{
  "updatedWebhookSettings": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "webhookUrl": "https://api.example.com/webhook/rhombus"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable
webhookSecretstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.