Trigger test event

POST

messaging

testing

{projectId}

events

Trigger test event

curl --request POST \
  --url https://api.polymorfa.com/messaging/testing/{projectId}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({session: '<string>'})
};

fetch('https://api.polymorfa.com/messaging/testing/{projectId}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/testing/{projectId}/events"

payload = { "session": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/messaging/testing/{projectId}/events"

	payload := strings.NewReader("{\n  \"session\": \"<string>\"\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))

}

{
  "event": "message.received",
  "session": "<string>",
  "delivery": "generated",
  "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "test"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "The request limit was reached. Follow Retry-After when supplied.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#rate-limit-exceeded"
}

{
  "error": {
    "type": "upstream_error",
    "code": "upstream_failure",
    "message": "The messaging provider could not complete the request.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#upstream-failure"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Headers

idempotency-key

string

Specifies idempotency key for this header parameter.

Value constraints

Constraint	Accepted input
Pattern	`^[\x21-\x7e]{1,255}$`
Optional. Repeating a request with the same key and body reuses the same event ID, so a retry after a failed or uncertain response never creates a second event or duplicate webhook deliveries.

Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

projectId

string<uuid>

required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

session

string

required

Test number session name in the project.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters

Required string length: 1 - 128

event

enum<string>

required

Fixture name. Each name is the event type it produces.

Allowed values

Value	Meaning
`message.received`	Message.received.
`message.ack`	Message.ack.
`message.failed`	Message.failed.
`call.received`	Call.received.
`call.missed`	Call.missed.
`call.ended`	Call.ended.
`session.status`	Session.status.
`template.status`	Template.status.
`bansafe.enforcement`	Bansafe.enforcement.
`bansafe.risk_changed`	Bansafe.risk changed.

Available options:

message.received,

message.ack,

message.failed,

call.received,

call.missed,

call.ended,

session.status,

template.status,

bansafe.enforcement,

bansafe.risk_changed

overrides

object

Specifies overrides for this native trigger test event request.

Show child attributes

fromSession

string

message.received only. Send a simulated text message from this other connected Test number in the same project instead of generating an event.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters

Required string length: 1 - 128

Response

Test event accepted for delivery

event

enum<string>

required

Specifies event for this native trigger test event response.

Allowed values

Value	Meaning
`message.received`	Message.received.
`message.ack`	Message.ack.
`message.failed`	Message.failed.
`call.received`	Call.received.
`call.missed`	Call.missed.
`call.ended`	Call.ended.
`session.status`	Session.status.
`template.status`	Template.status.
`bansafe.enforcement`	Bansafe.enforcement.
`bansafe.risk_changed`	Bansafe.risk changed.

Available options:

message.received,

message.ack,

message.failed,

call.received,

call.missed,

call.ended,

session.status,

template.status,

bansafe.enforcement,

bansafe.risk_changed

session

string

required

Identifier of the connected Polymorfa session.

delivery

enum<string>

required

Specifies delivery for this native trigger test event response.

Allowed values

Value	Meaning
`generated`	Generated.
`simulated`	Simulated.

Available options:

generated,

simulated

eventId

string<uuid> | null

required

Identifier for the event.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Format: `uuid`
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Format	`uuid`

source

enum<string>

required

Specifies source for this native trigger test event response.

Allowed values

Value	Meaning
`test`	Test.
`runtime`	Runtime.

Available options:

test,

runtime

Trigger test event

curl --request POST \
  --url https://api.polymorfa.com/messaging/testing/{projectId}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({session: '<string>'})
};

fetch('https://api.polymorfa.com/messaging/testing/{projectId}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/testing/{projectId}/events"

payload = { "session": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/messaging/testing/{projectId}/events"

	payload := strings.NewReader("{\n  \"session\": \"<string>\"\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))

}

{
  "event": "message.received",
  "session": "<string>",
  "delivery": "generated",
  "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "test"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "The request limit was reached. Follow Retry-After when supplied.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#rate-limit-exceeded"
}

{
  "error": {
    "type": "upstream_error",
    "code": "upstream_failure",
    "message": "The messaging provider could not complete the request.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#upstream-failure"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Trigger test event

Authorizations

Headers

Path Parameters

Body

Response