Track activity and engagement events

Track activity and engagement events for a specific delivery provider

Authorization

Authorization<token>

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

In: header

Request Body

application/jsonRequired

Webhook event payload from the delivery provider

[key: string]any

Path Parameters

environmentIdRequiredstring

The environment identifier

integrationIdRequiredstring

The integration identifier for the delivery provider

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

Successfully processed webhook events

responseRequiredarray<object>

export type Response = WebhookResultDto[];
 
export interface WebhookResultDto {
  /**
   * Unique identifier for the webhook result
   */
  id: string;
  /**
   * Event body containing the webhook event data
   */
  event: EventBody;
}
export interface EventBody {
  /**
   * Status of the event
   */
  status:
    | "opened"
    | "rejected"
    | "sent"
    | "deferred"
    | "delivered"
    | "bounced"
    | "dropped"
    | "clicked"
    | "blocked"
    | "spam"
    | "unsubscribed"
    | "delayed"
    | "complaint"
    | "created"
    | "accepted"
    | "queued"
    | "sending"
    | "failed"
    | "undelivered"
    | "dismissed";
  /**
   * Date of the event
   */
  date: string;
  /**
   * External ID from the provider
   */
  externalId?: string;
  /**
   * Number of attempts
   */
  attempts?: number;
  /**
   * Response from the provider
   */
  response?: string;
  /**
   * Raw content from the provider webhook
   */
  row?: string;
}

curl -X POST "https://api.novu.co/v2/inbound-webhooks/delivery-providers/string/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{}'