Skip to content
DEVELOPER DOCUMENTATION
/
/
Webhook Configuration
Last updated

Webhook configuration

You can efficiently manage and safeguard the communication between Namirial Onboarding and your systems, guaranteeing that all webhook notifications are delivered reliably and securely. Below is an example payload for a webhook notification presented in JSON format.

Example webhook payload in JSON

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "STATUS_UPDATE",
  "createdAt": "2024-10-29T17:42:16Z",
  "request": {
    "requestId": "123e4567-e89b-12d3-a456-426614174001",
    "requestTypeId": "123e4567-e89b-12d3-a456-426614174002",
    "status": "COMPLETED"
  }
}

The provided JSON payload represents a notification object that is used to inform about updates related to an onboarding request. Here is a detailed breakdown of each component:

  • id: This is a unique identifier for the notification, formatted as a UUIDv4. It ensures that each notification can be distinctly identified.

    • Example: "123e4567-e89b-12d3-a456-426614174000"

  • type: This field indicates the kind of update that triggered the notification. Currently, the example value is "STATUS_UPDATE", but additional values may be added over time to represent different types of updates.

    • Example: "STATUS_UPDATE"

  • createdAt: This timestamp indicates when the notification was created. It adheres to the ISO 8601 format for dates and times.

    • Example: "2024-10-29T17:42:16Z"

  • request: This nested object contains details about the specific onboarding request to which the notification pertains.

    • requestId: A unique identifier for the onboarding request, formatted as a UUIDv4.

      • Example: "123e4567-e89b-12d3-a456-426614174001"

    • requestTypeId: This field references the type of the request, also formatted as a UUIDv4. The actual value would depend on the preset workflow in the system.

      • Example: "123e4567-e89b-12d3-a456-426614174002"

    • status: This field indicates the current status of the request. Possible values include statuses such as "CREATED", "RUNNING", "COMPLETED", etc.

      • Example: "COMPLETED"

Webhook settings

Each request type can be linked to a specific webhook configuration, ensuring that notifications for that workflow are directed to the designated endpoint, which necessitates particular authentication.

The webhook settings include the following parameters.

Destination URL Configuration

This API call enables you to specify the destination URL where webhook notifications will be sent.

Authentication Methods

  • Client-Based Authentication: This method involves using client credentials to authenticate requests to the webhook URL. It ensures that only authorized clients can receive the webhook notifications.
  • HTTP Header-Based Authentication: This method supports various authentication schemes that utilize HTTP headers. You can configure headers such as Authorization, API-Key, or any custom headers required by your security protocols. This flexibility enables you to securely integrate webhook notifications into your existing infrastructure.

By using these API calls, you can effectively manage and secure the communication between Namirial Onboarding and your systems, ensuring that all webhook notifications are delivered reliably and securely.

Manage the type of webhooks setting

To set up request type webhook settings, please visit the following page Create request type webhooks settings.

For retrieving request type webhook settings, please refer to this page Get request type webhooks settings.

If you wish to delete request type webhook settings, please consult this page Delete request type webhooks settings.

Previous page
Next page