Send survey invitations from backend events with API triggers.

<?php
function queueSurveyInvitation($email, $name = '', array $metadata = array(), $delaySeconds = 0)
{
	$endpoint = 'https://survey.is/api/invitation-trigger';

	// Keep this token server-side. Anyone with it can queue invitations.
	$token = getenv('SURVEYIS_TRIGGER_TOKEN');
	if (!$token) {
		throw new RuntimeException('Missing Survey.is trigger token.');
	}

	$payload = array(
		'email' => $email,
		'name' => $name,
		'metadata' => $metadata,
	);

	// Optional: wait before Survey.is sends the invitation email.
	if ((int) $delaySeconds > 0) {
		$payload['send_in_seconds'] = (int) $delaySeconds;
	}

	$ch = curl_init($endpoint);
	curl_setopt_array($ch, array(
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_POST => true,
		CURLOPT_POSTFIELDS => json_encode($payload),
		CURLOPT_TIMEOUT => 30,
		CURLOPT_HTTPHEADER => array(
			'Authorization: Bearer ' . $token,
			'Content-Type: application/json',
		),
	));

	$body = curl_exec($ch);
	$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
	$error = curl_error($ch);
	curl_close($ch);

	if ($error || $httpCode < 200 || $httpCode >= 300) {
		throw new RuntimeException('Survey.is trigger failed: ' . ($error ?: $body));
	}

	return json_decode($body, true);
}

$result = queueSurveyInvitation(
	'customer@example.com',
	'Example Customer',
	// Metadata appears in Results after this recipient submits a response.
	array('order_id' => 'ord_1042', 'fulfillment_event' => 'delivered'),
	3 * 24 * 60 * 60
);

error_log('Queued Survey.is batch ' . $result['batch']['uuid']);

# Reads the trigger token from the server environment.
curl -sS -X POST 'https://survey.is/api/invitation-trigger' \
  -H "Authorization: Bearer $SURVEYIS_TRIGGER_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "customer@example.com",
    "name": "Example Customer",
    "send_in_seconds": 259200,
    "metadata": {
      "order_id": "ord_1042",
      "fulfillment_event": "delivered"
    }
  }'

import os
import requests

endpoint = "https://survey.is/api/invitation-trigger"
token = os.environ["SURVEYIS_TRIGGER_TOKEN"]

payload = {
    "email": "customer@example.com",
    "name": "Example Customer",
    # Delay three days before Survey.is sends the email.
    "send_in_seconds": 3 * 24 * 60 * 60,
    # Metadata is hidden from the respondent and available in Results.
    "metadata": {
        "order_id": "ord_1042",
        "fulfillment_event": "delivered",
    },
}

response = requests.post(
    endpoint,
    headers={"Authorization": f"Bearer {token}"},
    json=payload,
    timeout=30,
)

if not response.ok or not response.json().get("ok"):
    raise RuntimeError(f"Survey.is trigger failed: {response.status_code} {response.text}")

print("Queued Survey.is batch", response.json()["batch"]["uuid"])

const endpoint = "https://survey.is/api/invitation-trigger";
const token = process.env.SURVEYIS_TRIGGER_TOKEN;

const payload = {
  email: "customer@example.com",
  name: "Example Customer",
  // Delay three days before Survey.is sends the email.
  send_in_seconds: 3 * 24 * 60 * 60,
  // Metadata is hidden from the respondent and available in Results.
  metadata: {
    order_id: "ord_1042",
    fulfillment_event: "delivered"
  }
};

const response = await fetch(endpoint, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify(payload)
});

const data = await response.json();

if (!response.ok || !data.ok) {
  throw new Error(`Survey.is trigger failed: ${response.status} ${JSON.stringify(data)}`);
}

console.log(`Queued Survey.is batch ${data.batch.uuid}`);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	payload := map[string]interface{}{
		"email": "customer@example.com",
		"name": "Example Customer",
		// Delay three days before Survey.is sends the email.
		"send_in_seconds": 3 * 24 * 60 * 60,
		// Metadata is hidden from the respondent and available in Results.
		"metadata": map[string]string{
			"order_id": "ord_1042",
			"fulfillment_event": "delivered",
		},
	}

	body, _ := json.Marshal(payload)

	req, err := http.NewRequest("POST", "https://survey.is/api/invitation-trigger", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SURVEYIS_TRIGGER_TOKEN"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	responseBody, _ := io.ReadAll(resp.Body)
	if resp.StatusCode < 200 || resp.StatusCode >= 300 {
		panic(fmt.Sprintf("Survey.is trigger failed: %d %s", resp.StatusCode, responseBody))
	}

	fmt.Printf("Survey.is response: %s\n", responseBody)
}