Webhooks

Send a test delivery

Changed on

POST a signed sample event to a URL and report what came back, synchronously. Use it to check reachability and your signature verification before spending Creative Units on a real run. The sample carries type inference.completed with an empty data object, and is signed exactly as a real delivery is.

Nothing is charged, and no run is created.

post/v1/workspaces/{workspace_id}/webhook-tests

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v1/workspaces/{workspace_id}/webhook-tests
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.app.layer.ai/authorize, token URL https://auth.app.layer.ai/oauth/token)
    • OAuth 2 (client credentials, token URL https://api.app.layer.ai/api/oauth/token, scopes: workspace:write)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request body

Response

Successful Response

deliveredboolean required

Whether the receiver acknowledged with a 2xx.

response_statusinteger nullable

HTTP status the receiver returned, or null if it never responded.

latency_msinteger required

How long the attempt took, end to end.

errorstring nullable

Why the attempt did not succeed, when it did not.

Changes

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2d86d473cda6Revision changes
    • info

      the endpoint scheme security serviceAccount was added to the API

    • info

      the security scope workspace:write was removed from the endpoint's security scheme oauth2