2. Registration & Webhooks

The following methods are available via the AgriBackup SDK for this integration stage.

List Active Webhook Subscriptions

Retrieves all active webhook registrations registered for this organization. Cryptographic signing secrets are redacted for security.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.getWebhooks();
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.get_webhooks()
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.getWebhooks();
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.GetWebhooksAsync();
Console.WriteLine(response);

Register Webhook Endpoint

Registers an enterprise URL to receive asynchronous compliance events like shipment.linked and polygon.verified. Webhook payloads are cryptographically signed using HMAC-SHA256 with the generated signing secret, and sent in the 'X-AgriBackup-Signature' header for verification.

To verify webhook authenticity:

1. Extract the raw POST request body bytes/string.
2. Extract the signature value from the 'X-AgriBackup-Signature' HTTP header.
3. Calculate the HMAC-SHA256 hash of the raw body using the registered signing secret.
4. Hex-encode the calculated hash.
5. Perform a constant-time comparison between the hex-encoded hash and the header signature to avoid timing attacks.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const webhookRegistrationRequest = {
  "targetUrl": "https://erp.example.com/agribackup-webhooks",
  "eventTypes": [
    "shipment.linked"
  ]
};
const response = await client.webhooks.registerWebhook(webhookRegistrationRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import WebhookRegistrationRequest

client = AgriBackupClient('sk_live_...')
webhook_registration_request = WebhookRegistrationRequest(target_url="https://erp.example.com/agribackup-webhooks", event_types=["shipment.linked"])
response = client.webhooks.register_webhook(webhook_registration_request=webhook_registration_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.WebhookRegistrationRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var webhookRegistrationRequest = new WebhookRegistrationRequest()
    .target_url("https://erp.example.com/agribackup-webhooks")
    .event_types(Arrays.asList("shipment.linked"));
var response = client.webhooks.registerWebhook(webhookRegistrationRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var webhookRegistrationRequest = new WebhookRegistrationRequest {
    TargetUrl = "https://erp.example.com/agribackup-webhooks",
    EventTypes = new List<string> { "shipment.linked" }
};
var response = await client.Webhooks.RegisterWebhookAsync(webhookRegistrationRequest);
Console.WriteLine(response);

Rotate Webhook Secret

Regenerates and returns a new HMAC-SHA256 signing secret for the specified webhook subscription.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.rotateSecret('webhookId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.rotate_secret('webhookId')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.rotateSecret("webhookId");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.RotateSecretAsync("webhookId");
Console.WriteLine(response);

Webhook Cryptographic Handshake (Ping)

Dispatches a mock 'webhook.ping' event to the registered URL using the configured signing secret. This allows enterprise infosec teams to validate their HMAC-SHA256 signature verification algorithms in isolation without triggering a live data ingestion.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.pingWebhook('webhookId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.ping_webhook('webhookId')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.pingWebhook("webhookId");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.PingWebhookAsync("webhookId");
Console.WriteLine(response);

Replay a DLQ message to the primary exchange

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.replayDlqMessage('eventId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.replay_dlq_message('eventId')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.replayDlqMessage("eventId");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.ReplayDlqMessageAsync("eventId");
Console.WriteLine(response);

Replay multiple DLQ messages to the primary exchange

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const webhookDlqBulkRequest = {
  "eventIds": [
    "[\"evt_123\",\"evt_456\"]"
  ]
};
const response = await client.webhooks.replayBulkDlqMessages('startDate', 'endDate', 'eventType', webhookDlqBulkRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import WebhookDlqBulkRequest

client = AgriBackupClient('sk_live_...')
webhook_dlq_bulk_request = WebhookDlqBulkRequest(event_ids=["["evt_123","evt_456"]"])
response = client.webhooks.replay_bulk_dlq_messages('startDate', 'endDate', 'eventType', webhook_dlq_bulk_request=webhook_dlq_bulk_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.WebhookDlqBulkRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var webhookDlqBulkRequest = new WebhookDlqBulkRequest()
    .event_ids(Arrays.asList("["evt_123","evt_456"]"));
var response = client.webhooks.replayBulkDlqMessages("startDate", "endDate", "eventType", webhookDlqBulkRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var webhookDlqBulkRequest = new WebhookDlqBulkRequest {
    EventIds = new List<string> { "["evt_123","evt_456"]" }
};
var response = await client.Webhooks.ReplayBulkDlqMessagesAsync("startDate", "endDate", "eventType", webhookDlqBulkRequest);
Console.WriteLine(response);

Receive TRACES NT Clearance Webhook

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.api.handleClearanceWebhook('TracesWebhookPayload');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.api.handle_clearance_webhook('TracesWebhookPayload')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.api.handleClearanceWebhook("TracesWebhookPayload");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Api.HandleClearanceWebhookAsync("TracesWebhookPayload");
Console.WriteLine(response);

Retrieve permanently failed webhook payloads

Pulls failed webhook payloads from the Dead-Letter Queue (DLQ). These are messages that exhausted their retry limits.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.getDlqMessages('limit', 'startingAfter');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.get_dlq_messages('limit', 'startingAfter')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.getDlqMessages("limit", "startingAfter");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.GetDlqMessagesAsync("limit", "startingAfter");
Console.WriteLine(response);

Delete a Webhook Registration

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.deleteWebhook('webhookId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.delete_webhook('webhookId')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.deleteWebhook("webhookId");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.DeleteWebhookAsync("webhookId");
Console.WriteLine(response);

Acknowledge and delete a DLQ message

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.webhooks.deleteDlqMessage('eventId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.webhooks.delete_dlq_message('eventId')
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.webhooks.deleteDlqMessage("eventId");
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Webhooks.DeleteDlqMessageAsync("eventId");
Console.WriteLine(response);

Acknowledge and delete multiple DLQ messages

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const webhookDlqBulkRequest = {
  "eventIds": [
    "[\"evt_123\",\"evt_456\"]"
  ]
};
const response = await client.webhooks.deleteBulkDlqMessages(webhookDlqBulkRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import WebhookDlqBulkRequest

client = AgriBackupClient('sk_live_...')
webhook_dlq_bulk_request = WebhookDlqBulkRequest(event_ids=["["evt_123","evt_456"]"])
response = client.webhooks.delete_bulk_dlq_messages(webhook_dlq_bulk_request=webhook_dlq_bulk_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.WebhookDlqBulkRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var webhookDlqBulkRequest = new WebhookDlqBulkRequest()
    .event_ids(Arrays.asList("["evt_123","evt_456"]"));
var response = client.webhooks.deleteBulkDlqMessages(webhookDlqBulkRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var webhookDlqBulkRequest = new WebhookDlqBulkRequest {
    EventIds = new List<string> { "["evt_123","evt_456"]" }
};
var response = await client.Webhooks.DeleteBulkDlqMessagesAsync(webhookDlqBulkRequest);
Console.WriteLine(response);