Webhook

Test

Looking to test the webhook without uploading much media in your account ? Testing is made easier using this endpoint. You can trigger an event on a particular webhook and get the request\response or error.

post/webhook/test/{webhookId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/webhook/test/{webhookId}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

webhookIdstring required

Request body

event'embed_recorder.created' | 'embed_recorder.deleted' | 'embed_recorder.recording_received' | 'media.analyzed' | 'media.created' | 'media.deleted' | 'media.failed' | 'media.reanalyzed' | 'media.updated' | 'text.analyzed' | 'text.created' | 'text.deleted' | 'text.failed' | 'text.reanalyzed' | 'meeting_assistant.status' | 'chat.status' | 'csv.uploaded' | 'csv.failed' required

Pick the event to fire so you can see the request, the response and any error your endpoint returns. required; the 18 values come from the WebhookEvent list. No other body key is accepted, so any extra property returns a 400.

Response

OK

statusstring

Changes

No recorded changes to this operation across all 2 revisions of this API.