POST
/
v1
/
events
/
{event_name}
JavaScript
import Anchorbrowser from 'anchorbrowser';

const client = new Anchorbrowser({
  apiKey: 'Your API Key',
});

const successResponse = await client.events.signal('workflow_completed', {
  data: { message: 'bar', result: 'bar', timestamp: 'bar' },
});

console.log(successResponse.data);
{
  "data": {
    "status": "success"
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
event_name
string
required

The name of the event to signal

Example:

"workflow_completed"

Body

application/json
​
data
object
required

Event data to be passed to waiting clients

Example:
{
  "message": "Task completed",
  "result": "success",
  "timestamp": "2024-01-01T12:00:00Z"
}

Response

Event signaled successfully

​
data
object