Webhook
Mock endpoint that simulates the http request to the endpoint
curl --request POST \
--url https://api.uiform.com/v1/automations/links/tests/webhook/{link_id}
{
"object": "automation_log",
"id": "<string>",
"user_email": "jsmith@example.com",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"automation_snapshot": {
"object": "mailbox",
"id": "<string>",
"email": "<string>",
"authorized_domains": [
"<string>"
],
"authorized_emails": [
"jsmith@example.com"
],
"webhook_url": "<string>",
"webhook_headers": {},
"updated_at": "2023-11-07T05:31:56Z",
"modality": "text",
"image_settings": {
"correct_image_orientation": true,
"dpi": 123,
"image_to_text": "ocr",
"browser_canvas": "A3"
},
"model": "<string>",
"json_schema": {},
"temperature": 0,
"schema_data_id": "<string>",
"schema_id": "<string>"
},
"completion": {
"id": "<string>",
"choices": [
{
"finish_reason": "stop",
"index": 123,
"logprobs": {
"content": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
],
"refusal": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
]
},
"message": {
"content": "<string>",
"refusal": "<string>",
"role": "<string>",
"audio": {
"id": "<string>",
"data": "<string>",
"expires_at": 123,
"transcript": "<string>"
},
"function_call": {
"arguments": "<string>",
"name": "<string>"
},
"tool_calls": [
{
"id": "<string>",
"function": {
"arguments": "<string>",
"name": "<string>",
"parsed_arguments": "<any>"
},
"type": "<string>"
}
],
"parsed": "<any>"
}
}
],
"created": 123,
"model": "<string>",
"object": "<string>",
"service_tier": "scale",
"system_fingerprint": "<string>",
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123,
"completion_tokens_details": {
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"reasoning_tokens": 123,
"rejected_prediction_tokens": 123
},
"prompt_tokens_details": {
"audio_tokens": 123,
"cached_tokens": 123
}
},
"likelihoods": "<any>",
"schema_validation_error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_at": "2023-11-07T05:31:56Z",
"first_token_at": "2023-11-07T05:31:56Z",
"last_token_at": "2023-11-07T05:31:56Z"
},
"file_metadata": {
"filename": "file.pdf",
"url": "https://example.com/file.pdf"
},
"external_request_log": {
"webhook_url": "<string>",
"request_body": {},
"request_headers": {},
"request_at": "2023-11-07T05:31:56Z",
"response_body": {},
"response_headers": {},
"response_at": "2023-11-07T05:31:56Z",
"status_code": 123,
"error": "<string>",
"duration_ms": 123
},
"api_cost": {
"value": 123,
"currency": "<string>"
}
}
Path Parameters
Response
Url of the webhook to send the data to
1 - 2083
text
, image
, native
, image+text
Model used for chat completion
JSON schema format used to validate the output data.
Returns the SHA1 hash of the schema data, ignoring all prompt/description/default fields.
Returns: str: A SHA1 hash string representing the schema data version.
Returns the SHA1 hash of the complete schema.
Returns: str: A SHA1 hash string representing the complete schema version.
"mailbox"
Unique identifier for the mailbox
List of authorized domains to receive the emails from
List of emails to access the link
Headers to send with the request
Preprocessing operations applied to image before sending them to the llm
ocr
, llm_description
A3
, A4
, A5
Temperature for sampling. If not provided, the default temperature for the model will be used.
stop
, length
, tool_calls
, content_filter
, function_call
"assistant"
"chat.completion"
scale
, default
Timestamp of the request
Timestamp of the first token of the document. If non-streaming, set to last_token_at
Timestamp of the last token of the document
1 - 2083
"automation_log"
Unique identifier for the automation log
curl --request POST \
--url https://api.uiform.com/v1/automations/links/tests/webhook/{link_id}
{
"object": "automation_log",
"id": "<string>",
"user_email": "jsmith@example.com",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"automation_snapshot": {
"object": "mailbox",
"id": "<string>",
"email": "<string>",
"authorized_domains": [
"<string>"
],
"authorized_emails": [
"jsmith@example.com"
],
"webhook_url": "<string>",
"webhook_headers": {},
"updated_at": "2023-11-07T05:31:56Z",
"modality": "text",
"image_settings": {
"correct_image_orientation": true,
"dpi": 123,
"image_to_text": "ocr",
"browser_canvas": "A3"
},
"model": "<string>",
"json_schema": {},
"temperature": 0,
"schema_data_id": "<string>",
"schema_id": "<string>"
},
"completion": {
"id": "<string>",
"choices": [
{
"finish_reason": "stop",
"index": 123,
"logprobs": {
"content": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
],
"refusal": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123,
"top_logprobs": [
{
"token": "<string>",
"bytes": [
123
],
"logprob": 123
}
]
}
]
},
"message": {
"content": "<string>",
"refusal": "<string>",
"role": "<string>",
"audio": {
"id": "<string>",
"data": "<string>",
"expires_at": 123,
"transcript": "<string>"
},
"function_call": {
"arguments": "<string>",
"name": "<string>"
},
"tool_calls": [
{
"id": "<string>",
"function": {
"arguments": "<string>",
"name": "<string>",
"parsed_arguments": "<any>"
},
"type": "<string>"
}
],
"parsed": "<any>"
}
}
],
"created": 123,
"model": "<string>",
"object": "<string>",
"service_tier": "scale",
"system_fingerprint": "<string>",
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123,
"completion_tokens_details": {
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"reasoning_tokens": 123,
"rejected_prediction_tokens": 123
},
"prompt_tokens_details": {
"audio_tokens": 123,
"cached_tokens": 123
}
},
"likelihoods": "<any>",
"schema_validation_error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"request_at": "2023-11-07T05:31:56Z",
"first_token_at": "2023-11-07T05:31:56Z",
"last_token_at": "2023-11-07T05:31:56Z"
},
"file_metadata": {
"filename": "file.pdf",
"url": "https://example.com/file.pdf"
},
"external_request_log": {
"webhook_url": "<string>",
"request_body": {},
"request_headers": {},
"request_at": "2023-11-07T05:31:56Z",
"response_body": {},
"response_headers": {},
"response_at": "2023-11-07T05:31:56Z",
"status_code": 123,
"error": "<string>",
"duration_ms": 123
},
"api_cost": {
"value": 123,
"currency": "<string>"
}
}