Track activity and engagement events

POST

inbound-webhooks

delivery-providers

{environmentId}

{integrationId}

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->activity->track(
    environmentId: '<id>',
    integrationId: '<id>',
    requestBody: [

    ]

);

if ($response->webhookResultDtos !== null) {
    // handle response
}

[
  {
    "id": "<string>",
    "event": {
      "date": "<string>",
      "externalId": "<string>",
      "attempts": 123,
      "response": "<string>",
      "row": "<string>"
    }
  }
]

Authorizations

Authorization

string

header

required

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

Headers

idempotency-key

string

A header for idempotency purposes

Path Parameters

environmentId

string

required

The environment identifier

integrationId

string

required

The integration identifier for the delivery provider

Body

application/json

Webhook event payload from the delivery provider

Generic webhook payload from delivery providers

Response

200 - application/json

Successfully processed webhook events

string

required

Unique identifier for the webhook result

event

object

required

Event body containing the webhook event data

Show child attributes

List all channel endpoints

Create a layout

⌘I

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->activity->track(
    environmentId: '<id>',
    integrationId: '<id>',
    requestBody: [

    ]

);

if ($response->webhookResultDtos !== null) {
    // handle response
}

[
  {
    "id": "<string>",
    "event": {
      "date": "<string>",
      "externalId": "<string>",
      "attempts": 123,
      "response": "<string>",
      "row": "<string>"
    }
  }
]