Skip to main content

Understanding Webhook in Blueink

Raymund Mission avatar
Written by Raymund Mission
Updated over 3 weeks ago

Introduction:

The Webhook Log Page in Blueink provides users with a detailed history of webhook events, allowing them to monitor successful and failed webhook deliveries. Additionally, users can enable or disable webhooks as needed to control which events trigger notifications to their endpoints.

How to Access the Webhook Log Page

  1. Navigate to the API Dashboard

    • Go to the Blueink dashboard.

    • Click on API from the left-hand menu.
      ​

    • Select Webhooks to access the list of configured webhooks.

  2. View Webhook Logs

    • Click the View Logs button next to the webhook you want to inspect.

    • This will open the Webhook Log Page, showing the request status, HTTP codes, event types, and timestamps.

  3. Check Specific Webhook Events

    • Click on a specific webhook event to view detailed information.

    • The event details include:

      • URL of the webhook endpoint

      • Webhook Type (e.g., document completed, bundle ready, etc.)

      • Status (Success or Failed)

      • HTTP Code (200 for successful requests, 4xx/5xx for failures)

      • Error Messages (if applicable)

      • Payload Data

  4. Resend a Failed Webhook Event

    • If a webhook event failed, you can manually retry by clicking the Resend button.

How to Enable or Disable a Webhook

  1. Go to the Webhook Settings

    • Navigate to API > Webhooks in the Blueink dashboard.

    • Find the webhook you want to manage.
      ​
      ​

  2. Toggle the Enable/Disable Switch

    • Click on the webhook entry to open its settings.

    • Use the Enable/Disable toggle switch at the top.

    • Click Save to confirm changes.

  3. Effect of Disabling a Webhook

    • A disabled webhook will no longer send event notifications.

    • The webhook status will be marked as Disabled in the Webhook List.

    • If a webhook continues failing multiple times, it will be automatically disabled and marked as Disabled (Failed Deliveries).

    • Logs for past events will remain accessible.

  4. Re-enabling a Webhook

    • To reactivate the webhook, toggle it back to Enabled and save the changes.

    • Webhook events will resume as per the subscribed event types.

Troubleshooting Webhook Issues

  • 404 Error: Ensure the webhook URL is correct and the receiving server is active.

  • 403 Error: Verify authentication credentials and permissions for the webhook.

  • Failed Deliveries: Check server logs and ensure the endpoint is configured to accept webhook requests.

  • Resend Failed Events: Click Resend in the Webhook Log Page to manually trigger a failed event.

Conclusion:

The Webhook Log Page and the Enable/Disable feature provide greater control over webhook functionality in Blueink. By monitoring webhook logs and managing webhook activation, users can ensure seamless API integrations for document workflows.
​
Need more help? Contact us directly here and our team will be happy to assist you!

Did this answer your question?