Auto-configure an integration for inbound webhooks

Auto-configure an integration by its unique key identifier integrationId for inbound webhook support. This will automatically generate required webhook signing keys and configure webhook endpoints.

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

In: header

Path Parameters

integrationIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

successRequiredboolean

Indicates whether the auto-configuration was successful

messagestring

Optional message describing the result or any errors that occurred

integrationobject

The updated configurations after auto-configuration

export interface Response {
  /**
   * Indicates whether the auto-configuration was successful
   */
  success: boolean;
  /**
   * Optional message describing the result or any errors that occurred
   */
  message?: string;
  /**
   * The updated configurations after auto-configuration
   */
  integration?: {};
}

curl -X POST "https://api.novu.co/v1/integrations/string/auto-configure" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "success": true,
  "message": "string",
  "integration": {}
}

Auto-configure an integration for inbound webhooks

Authorization

Path Parameters

Header Parameters

Response Body

On this page