👋Webhook API

To access your struct via API you can use the Structize Websocket API.

You can access the Websocket API via wss://socket.structize.com

You will need an api_key and the id of your struct struct_id to use the webhook. These keys can be found in the Structize App.

Here is a short code example in both Python and JavaScript:

Python

import websockets
import json
import time


async def test():
    uri = "wss://socket.structize.com"
    async with websockets.connect(uri) as websocket:
        await websocket.send(
            json.dumps(
                {
                    "api_key": "your_api_key",
                    "struct_id": "your_struct_id",
                    "text": "A text about a beautiful girl in a red dress",
                    "meta_data": {
                        "some_key": "your_optional_meta_data_you_want_in_the_repy_message",
                    }
                }
            )
        )

        try:
            start = time.time()
            # Continuously receive messages until server disconnects for max 15 minutes
            while time.time() < start + 910:
                message = await websocket.recv()
                print(message)
        except websockets.exceptions.ConnectionClosed:
            print("Connection closed by the server.")

await test()

JavaScript

const WebSocket = require('ws'); // Use this line if you're using Node.js

async function test() {
  const uri = "wss://socket.structize.com";
  const ws = new WebSocket(uri);

  ws.on('open', function open() {
    const data = JSON.stringify({
      "api_key": "your_api_key",
      "struct_id": "your_struct_id",
      "text": "A text about a beautiful girl in a red dress",
      "meta_data": {
        "some_key": "your_optional_meta_data_you_want_in_the_repy_message",
      },
    });

    ws.send(data);
  });

  ws.on('message', function incoming(message) {
    console.log('received: %s', message);
  });

  ws.on('error', function error(error) {
    console.log('WebSocket error: ' + error.message);
  });

  // Handle the WebSocket closing (you can customize as needed)
  ws.on('close', function close() {
    console.log('Connection closed by the server.');
  });
}

// Call the test function if running in a Node.js environment
// If using in a browser, you might need to adapt the code (e.g., removing the require statement).
test();

If the authentication is successful you will first receive a success message:

{
  "status": "success",
  "message": "Authentication successful"
}

Once the authentication is successful, you will receive a message that we are processing your input and that the structizing has started:

{
  "status": "processing",
  "message": "Structizing the text..."
}

After about 10 seconds or up to several minutes for large structs you should receive the output in the following format:

{
  "status": "done",
  "struct": {
    "rationale": {
      "question_1_key": "rationale_for_the_answer_to_question_1",
      "question_2_key": "rationale_for_the_answer_to_question_2",
      ...
    },
    "question_1_key": answer_to_question_1,
    "question_2_key": answer_to_question_2,
    ...
  }
}

For more details you can check out our swagger on https://socket-docs.structize.com