Skip to end of banner
Go to start of banner

Create request type webhooks setting

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Current »

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)

Path parameters

  • id (required): The unique identifier for the request type.

Example cURL API call

curl -X POST "https://test.onboarding.namirial.app/api/v2/requestType/YOUR_REQUEST_TYPE_ID/webhookConfigurations" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{
  "url": "https://your.domain/webhook",
  "authentication": {
    "headers": {
      "Authorization": "Bearer listening-server-token",
      "API-Key": "listening-server-api-key",
      "additionalProp3": "string",
      "additionalProp4": "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:

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