Content Comparison

...

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 type webhooks setting

This API call allows you to create a webhook configuration for a specific request type. The webhook configuration includes the destination URL and the authentication method required for the webhook notifications.

Endpoint

• URL: /requestType/{id}/webhookConfigurations

• Method: POST

Headers

Ensure you include the following headers in your request:

• Accept: application/json

• Content-Type: application/json

• X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Parameters

• id: The unique identifier for the request type.

Example Request Body

{
  "url": "https://your.domain/webhook",
  "authentication": {
    "headers": {
      "Authorization": "Bearer your-token",
      "API-Key": "your-api-key",
      "additionalProp3": "string"
    },
    "client_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIH/TCCBeWgAwIBAgIQaBYE3/M08XHYCnNVmcFBcjANBgkqhkiG9w0BAQsFADBy\n...",
    "client_cert": "-----BEGIN CERTIFICATE-----\nMIIH/TCCBeWgAwIBAgIQaBYE3/M08XHYCnNVmcFBcjANBgkqhkiG9w0BAQsFADBy\n..."
  }
}

Responses

• 200 OK

  • Description: The webhook settings created.

  • Example Response:

    Code Block
    language json
    { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "url": "https://your.domain/webhook", "createdAt": "2024-10-22T12:19:12.269594Z" }

• 400 Bad Request

  • Description: Bad Request described following Problem Details (RFC 9457).

  • Example Response:

    Code Block
    language json
    { "type": "about:blank", "status": 400, "title": "Request validation error", "detail": "The has a malformed body property.", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463", "retryable": false, "errors": [ { "detail": "Property 'dummyField' is not defined in the schema and the schema does not allow additional properties.", "pointer": "/parameters/dummyField", "field": "dummyField", "reason": "additionalProperties" } ] }

Get Request Type Webhooks Configurations

This API call allows you to retrieve the webhook configurations associated with a specific request type. These configurations include details such as the destination URL and the creation timestamp.

Endpoint

• URL: /requestType/{id}/webhookConfigurations

• Method: GET

Headers

Ensure you include the following headers in your request:

• Accept: application/json

• Content-Type: application/json

• X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Parameters

• id: The unique identifier for the request type, formatted as a UUID.

Responses

• 200 OK

  • Description: The webhook configurations for the specified request type.

  • Example Response:

    Code Block
    language json
    { "content": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "url": "https://your.domain/webhook", "createdAt": "2024-10-22T12:19:12.269594Z" } ] }

• 400 Bad Request

  • Description: Bad Request described following Problem Details (RFC 9457).

  • Example Response:

    Code Block
    language json
    { "type": "about:blank", "status": 400, "title": "Request validation error", "detail": "The has a malformed body property.", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463", "retryable": false, "errors": [ { "detail": "Property 'dummyField' is not defined in the schema and the schema does not allow additional properties.", "pointer": "/parameters/dummyField", "field": "dummyField", "reason": "additionalProperties" } ] }

Delete Webhook Setting

This API call allows you to delete a specific webhook configuration associated with a request type.

Endpoint

• URL: /requestType/{id}/webhookConfigurations/{webhookConfigurationId}

• Method: DELETE

Headers

Ensure you include the following headers in your request:

• Accept: application/json

• Content-Type: application/json

• X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Parameters

• id: The unique identifier for the request type.

• webhookConfigurationId: The unique identifier for the webhook configuration, formatted as a UUID.

Responses

...

204 No Content

• Description: The resource was deleted successfully.

400 Bad Request

...

Description: Bad Request described following Problem Details (RFC 9457).

Example Response:

...

...

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

For retrieving request type webhook settings, kindly refer to this page: Get request type webhooks setting.

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