Get request type webhooks setting

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)

Pat parameters

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

Example cURL API call

curl -X GET "https://test.onboarding.namirial.app/api/v2/requestType/YOUR_REQUEST_TYPE_ID/webhookConfigurations" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"

Responses

• 200 OK

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

  • Example Response:

    {
      "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:

    {
      "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"
        }
      ]
    }