Setting Custom Webhooks

How It Works

MyTags will send a POST request to your configured URL with a JSON payload whenever a subscribed event occurs.

Setting Up a Webhook

Navigate to the Integrations page.
Ensure you are on the Webhooks tab.
Click the Add (+) button.

Configuration Fields

Webhook URL: The destination URL where we should send the POST request. Must start with https://.
- Example: https://api.yourdomain.com/webhooks/mytags
Event Types: Select which events should trigger this webhook:
- Asset Scanned: Triggered when an asset's QR code is scanned.
- Asset Reported: Triggered when a finder contacts you via the report form.
Headers (Optional): JSON object containing custom headers to include in the request. Useful for authentication tokens.
- Format: Must be a valid JSON object with string values.
- Example:
```
{
  "Authorization": "Bearer your-secret-token",
  "X-Custom-Source": "MyTags"
}
```

Click Save Webhook.

Testing

You can't explicitly "test" a generic webhook in the UI currently, but you can trigger it by scanning one of your own tags to verify the asset_scanned event.

Common Issues

Problem: "Headers must be a valid JSON object"

Solution: Ensure you are using double quotes for keys and values and valid JSON syntax (no trailing commas).

Webhook Payload

The payload contains details about the event, the asset involved, and any scan data (IP, location).

[Link to Developer Documentation for Payload Examples]

Related:

Slack Integration