Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 200 OK

    • Description: The webhook settings created.

    • Example Response:

      Code Block
      languagejson
      {
        "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
      languagejson
      {
        "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 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.

...

  • 200 OK

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

    • Example Response:

      Code Block
      languagejson
      {
        "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
      languagejson
      {
        "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

...

request type webhooks setting

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

...