HAhappyscribe
Webhook endpoints

Send a test event

Sends a signed sample event to the endpoint and answers once your receiver has, so deliveries[0].last_attempt.response_code is what it returned. A receiver that fails is retried like any delivery. The sample's ids do not exist, so do not fetch them. Up to 10 test events per workspace per minute.

post/webhook_endpoints/{id}/test

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Request body

typestring

The event to send. Defaults to the first event the endpoint subscribes to.

Example request

{
  "type": "bot.summary_ready"
}

Response

The test event, with this endpoint's delivery.

idstring

The event's ID, the same id your receiver got in the payload.

objectstring

Always webhook_event.

typestring

The event type, as this request's API version names it.

workspace_idstring

Workspace ID, beginning with wks_.

testboolean

A sample sent with POST /webhook_endpoints/{id}/test.

created_atstring date-time

When the event happened, in ISO 8601.

Example response

{
  "id": "evt_01k0h4x0n7r2c5m8q9v3b6d1ef",
  "type": "meeting.finished",
  "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
  "deliveries": [
    {
      "endpoint_id": "whe_01k6d4a1b2c3d4e5f6g7h8j9km",
      "last_attempt": {
        "response_code": 500
      },
      "attempts": [
        {
          "response_code": 500
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.