Functions

Create function triggers

Subscribe a function to one or more event types, optionally scoped to specific senders. Provide eventTypes and senderIds (use null in senderIds for all senders); a trigger is created for each event type and sender combination.

The special event type cron runs the function on a schedule instead of a messaging event: include a cron field with a 5-field UTC cron expression (minimum granularity one minute). A cron trigger ignores the sender axis, and a function may hold several cron triggers with different expressions. The function receives an event with type: "cron" and data.cron.

POST

functions

{functionId}

triggers

Create function triggers

curl --request POST \
  --url https://api.zavu.dev/v1/functions/{functionId}/triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTypes": [
    "message.inbound"
  ],
  "senderIds": [
    null
  ]
}
'

import requests

url = "https://api.zavu.dev/v1/functions/{functionId}/triggers"

payload = {
    "eventTypes": ["message.inbound"],
    "senderIds": [None]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({eventTypes: ['message.inbound'], senderIds: [null]})
};

fetch('https://api.zavu.dev/v1/functions/{functionId}/triggers', 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.zavu.dev/v1/functions/{functionId}/triggers",
  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([
    'eventTypes' => [
        'message.inbound'
    ],
    'senderIds' => [
        null
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.zavu.dev/v1/functions/{functionId}/triggers"

	payload := strings.NewReader("{\n  \"eventTypes\": [\n    \"message.inbound\"\n  ],\n  \"senderIds\": [\n    null\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.zavu.dev/v1/functions/{functionId}/triggers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"eventTypes\": [\n    \"message.inbound\"\n  ],\n  \"senderIds\": [\n    null\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/functions/{functionId}/triggers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"eventTypes\": [\n    \"message.inbound\"\n  ],\n  \"senderIds\": [\n    null\n  ]\n}"

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

{
  "added": 123,
  "skipped": 123,
  "triggers": [
    {
      "id": "<string>",
      "functionId": "<string>",
      "eventType": "<string>",
      "active": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "senderId": "<string>",
      "cron": "*/15 * * * *",
      "nextRunAt": "2023-11-07T05:31:56Z",
      "lastRunAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

functionId

string

required

Zavu Function ID.

Body

application/json

eventTypes

string[]

required

Event types to subscribe to.

senderIds

(string | null)[]

required

Senders to scope the triggers to. Use null for all senders.

cron

string

Required when eventTypes includes cron: a 5-field cron expression (minute hour day-of-month month day-of-week), evaluated in UTC.

Example:

"0 9 * * 1-5"

Response

Triggers created.

added

integer

required

skipped

integer

required

Number of triggers that already existed.

triggers

object[]

required

Show child attributes

⌘I

Create function triggers

curl --request POST \
  --url https://api.zavu.dev/v1/functions/{functionId}/triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTypes": [
    "message.inbound"
  ],
  "senderIds": [
    null
  ]
}
'

import requests

url = "https://api.zavu.dev/v1/functions/{functionId}/triggers"

payload = {
    "eventTypes": ["message.inbound"],
    "senderIds": [None]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({eventTypes: ['message.inbound'], senderIds: [null]})
};

fetch('https://api.zavu.dev/v1/functions/{functionId}/triggers', 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.zavu.dev/v1/functions/{functionId}/triggers",
  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([
    'eventTypes' => [
        'message.inbound'
    ],
    'senderIds' => [
        null
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.zavu.dev/v1/functions/{functionId}/triggers"

	payload := strings.NewReader("{\n  \"eventTypes\": [\n    \"message.inbound\"\n  ],\n  \"senderIds\": [\n    null\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.zavu.dev/v1/functions/{functionId}/triggers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"eventTypes\": [\n    \"message.inbound\"\n  ],\n  \"senderIds\": [\n    null\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/functions/{functionId}/triggers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"eventTypes\": [\n    \"message.inbound\"\n  ],\n  \"senderIds\": [\n    null\n  ]\n}"

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

{
  "added": 123,
  "skipped": 123,
  "triggers": [
    {
      "id": "<string>",
      "functionId": "<string>",
      "eventType": "<string>",
      "active": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "senderId": "<string>",
      "cron": "*/15 * * * *",
      "nextRunAt": "2023-11-07T05:31:56Z",
      "lastRunAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}