NAnatural
Webhooks

Create webhook

Changed on

Create a webhook endpoint. The signing secret is returned only once.

post/webhooks

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/webhooks
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes

  • 6663cdab7a7cRevision changes
    • warning

      added the new voiceSession.completed enum value to the /// response property for the response status

    • info

      added the new voiceSession.completed enum value to the request property ///

  • 6e52d1bd0054Revision changes
    • warning

      added the new check.canceled enum value to the /// response property for the response status

    • warning

      added the new check.completed enum value to the /// response property for the response status

    • warning

      added the new check.created enum value to the /// response property for the response status

    • warning

      added the new check.expired enum value to the /// response property for the response status

    • warning

      added the new check.failed enum value to the /// response property for the response status

    • warning

      added the new check.processing enum value to the /// response property for the response status

    • warning

      added the new check.rejected enum value to the /// response property for the response status

    • warning

      added the new check.returned enum value to the /// response property for the response status

    • warning

      added the new check.returned_to_sender enum value to the /// response property for the response status

    • info

      added the new check.canceled enum value to the request property ///

    • info

      added the new check.completed enum value to the request property ///

    • info

      added the new check.created enum value to the request property ///

    • info

      added the new check.expired enum value to the request property ///

    • info

      added the new check.failed enum value to the request property ///

    • info

      added the new check.processing enum value to the request property ///

    • info

      added the new check.rejected enum value to the request property ///

    • info

      added the new check.returned enum value to the request property ///

    • info

      added the new check.returned_to_sender enum value to the request property ///