Webhooks

Notification

Manually send notifications to webhooks for testing, retrying failed deliveries, or replaying events.

Chunkify automatically sends notifications to your webhooks when certain events occur. But you can also manually send a notification to one of your webhooks.

Use cases

It can be useful in some cases for example:

When the notification delivery failed, if you endpoint was down when Chunkify send the automatic notification.
When you want to trigger some event to test your webhook integration.
If you need to replay an event to retrigger a workflow in your system.

Notification creation

You need to provide an existing webhook ID and an existing object ID. For job events, use a job ID. For upload events, use an upload ID.

A maximum of 5 notifications can be created per object ID.

Here is an example to create a notification for the job.completed event:

 import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
    projectAccessToken: 'My Project Access Token',
});

// Create a Notification
const notification = await client.notifications.create({
    webhook_id: 'your_webhook_id',
    object_id: 'your_job_id',
    event: 'job.completed',
});
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)

# Create a Notification
notification = client.notifications.create(
    webhook_id="your_webhook_id",
    object_id="your_job_id",
    event="job.completed",
)
use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

// Create a Notification
$notification = $client->notifications->create(
    webhookID: 'your_webhook_id',
    objectID: 'your_job_id',
    event: 'job.completed',
);
import (
        "context"
        "github.com/chunkifydev/chunkify-go"
        "github.com/chunkifydev/chunkify-go/option"
    )
    
client := chunkify.NewClient(
    option.WithProjectAccessToken("My Project Access Token"),
)

// Create a Notification
notificationParams := chunkify.NotificationNewParams{
	WebhookID: "your_webhook_id",
	ObjectID:  "your_job_id",
	Event:     "job.completed",
}

notification, err := client.Notifications.New(context.TODO(), notificationParams)
if err != nil {
	log.Fatal("Error creating notification")
}