HAhappyscribe
Webhook events

List webhook events

The events sent to the endpoints of the workspaces the key administers, newest first, for 90 days. Each carries how every delivery went; fetch one event for its payload and each attempt. Only events some endpoint subscribed to are kept.

To recover after an outage, list the events with delivery_status=failed since it started and process the ones you have not stored.

get/webhook_events

Request

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

Query parameters

workspace_idstring
Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Only this workspace's events. A wks_ id; integer workspace ids are still accepted.

typestring
Example:meeting.finished

Only events of this type.

endpoint_idstring
Example:whe_01k6d4a1b2c3d4e5f6g7h8j9km

Only events delivered to this endpoint.

delivery_status'pending' | 'succeeded' | 'failed' | 'cancelled'

Only events with a delivery in this state, to endpoint_id when given.

  • pending: not answered yet.
  • succeeded: your receiver returned 2xx.
  • failed: its last attempt failed; it is retried until it succeeds or 21 attempts are used.
  • cancelled: the endpoint was disabled, stopped receiving the event, or could not be sent to.
created_afterstring date-time

Only events at or after this ISO 8601 time.

created_beforestring date-time

Only events before this ISO 8601 time.

limitinteger

Page size, 1 to 100.

cursorstring

Opaque. Follow _links.next.url rather than building it.

Response

One page of events, without their payloads.

objectstring

Always list.

has_moreboolean

Whether more results follow this page.

Example response

{
  "data": [
    {
      "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.