Send a workflow event

curl --request POST \
  --url https://api.osvi.ai/v1/campaigns/{id}/events \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "payment_received",
  "phone": "+919876543210",
  "client_event_id": "pay_8XK2",
  "data": {
    "amount": 5000,
    "method": "upi"
  }
}
'

import requests

url = "https://api.osvi.ai/v1/campaigns/{id}/events"

payload = {
    "event": "payment_received",
    "phone": "+919876543210",
    "client_event_id": "pay_8XK2",
    "data": {
        "amount": 5000,
        "method": "upi"
    }
}
headers = {
    "API-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'API-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event: 'payment_received',
    phone: '+919876543210',
    client_event_id: 'pay_8XK2',
    data: {amount: 5000, method: 'upi'}
  })
};

fetch('https://api.osvi.ai/v1/campaigns/{id}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osvi.ai/v1/campaigns/{id}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event' => 'payment_received',
    'phone' => '+919876543210',
    'client_event_id' => 'pay_8XK2',
    'data' => [
        'amount' => 5000,
        'method' => 'upi'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "API-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osvi.ai/v1/campaigns/{id}/events"

	payload := strings.NewReader("{\n  \"event\": \"payment_received\",\n  \"phone\": \"+919876543210\",\n  \"client_event_id\": \"pay_8XK2\",\n  \"data\": {\n    \"amount\": 5000,\n    \"method\": \"upi\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.osvi.ai/v1/campaigns/{id}/events")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"payment_received\",\n  \"phone\": \"+919876543210\",\n  \"client_event_id\": \"pay_8XK2\",\n  \"data\": {\n    \"amount\": 5000,\n    \"method\": \"upi\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.osvi.ai/v1/campaigns/{id}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"payment_received\",\n  \"phone\": \"+919876543210\",\n  \"client_event_id\": \"pay_8XK2\",\n  \"data\": {\n    \"amount\": 5000,\n    \"method\": \"upi\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "event_id": 481,
    "status": "matched",
    "duplicate": false,
    "run_ref": "R-1042"
  }
}

Campaigns

Send a Workflow Event

Tells a workflow campaign that something happened for a contact (a payment, a signed form), for its Await (event) blocks. Every event is kept: one that arrives before the contact reaches the Await still counts when they get there (if it arrived after they entered the workflow). A contact already waiting for it moves on at once by the Await’s Received path; one that isn’t waiting takes Timed out when the Await’s time limit passes. The event’s data is what later Conditionals read as the event’s fields.

POST

campaigns

{id}

events

Send a workflow event

curl --request POST \
  --url https://api.osvi.ai/v1/campaigns/{id}/events \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "payment_received",
  "phone": "+919876543210",
  "client_event_id": "pay_8XK2",
  "data": {
    "amount": 5000,
    "method": "upi"
  }
}
'

import requests

url = "https://api.osvi.ai/v1/campaigns/{id}/events"

payload = {
    "event": "payment_received",
    "phone": "+919876543210",
    "client_event_id": "pay_8XK2",
    "data": {
        "amount": 5000,
        "method": "upi"
    }
}
headers = {
    "API-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'API-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event: 'payment_received',
    phone: '+919876543210',
    client_event_id: 'pay_8XK2',
    data: {amount: 5000, method: 'upi'}
  })
};

fetch('https://api.osvi.ai/v1/campaigns/{id}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osvi.ai/v1/campaigns/{id}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event' => 'payment_received',
    'phone' => '+919876543210',
    'client_event_id' => 'pay_8XK2',
    'data' => [
        'amount' => 5000,
        'method' => 'upi'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "API-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osvi.ai/v1/campaigns/{id}/events"

	payload := strings.NewReader("{\n  \"event\": \"payment_received\",\n  \"phone\": \"+919876543210\",\n  \"client_event_id\": \"pay_8XK2\",\n  \"data\": {\n    \"amount\": 5000,\n    \"method\": \"upi\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.osvi.ai/v1/campaigns/{id}/events")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"payment_received\",\n  \"phone\": \"+919876543210\",\n  \"client_event_id\": \"pay_8XK2\",\n  \"data\": {\n    \"amount\": 5000,\n    \"method\": \"upi\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.osvi.ai/v1/campaigns/{id}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"payment_received\",\n  \"phone\": \"+919876543210\",\n  \"client_event_id\": \"pay_8XK2\",\n  \"data\": {\n    \"amount\": 5000,\n    \"method\": \"upi\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "event_id": 481,
    "status": "matched",
    "duplicate": false,
    "run_ref": "R-1042"
  }
}

Preview. Workflow campaigns are being rolled out to pilot accounts.

Use this when a workflow waits for something to happen outside Osvi: a payment, a signed form, a visit. Put an Await block set to Event in the workflow, name the event (for example payment_received), and have your system send that event here with the contact’s phone number when it happens.

Early events count. An event that arrives before the contact reaches the Await is kept, and counts the moment they get there (as long as it arrived after they entered the workflow).
One event moves one contact on, once. Send a client_event_id to make retries safe.
What it brings. Later Conditionals can check the event’s data fields (for example, “amount is greater than 1000”).
Testing. In the workflow editor, an Await (event) block waiting in a test run has Send test event, and For your developer shows this request ready to copy.

Authorizations

API-Token

string

header

required

16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.

Path Parameters

integer

required

The workflow campaign's numeric id.

Body

application/json

event

string

required

The event's name, as the Await block names it.

Maximum string length: 100

Example:

"payment_received"

phone

string

The contact's phone number, as in their batch (10-digit Indian mobile numbers and +91 numbers are matched either way). Give this or run_ref.

Maximum string length: 32

Example:

"+919876543210"

run_ref

string

One run, as Logs shows it (R-1042), instead of a phone number. A test run is only reached this way.

Example:

"R-1042"

client_event_id

string

Your own id for the event. Sending the same id again changes nothing (safe retries).

Maximum string length: 200

Example:

"pay_8XK2"

data

object

Anything about the event later blocks can check, up to 8 KB.

Example:

{ "amount": 5000, "method": "upi" }

Response

Event received.

success

boolean

Example:

true

data

object

Show child attributes

Get Started

Going Deeper

Chat SDK

API Reference

Send a Workflow Event

Authorizations

Path Parameters

Body

Response