Input schema (JSON)
{
"type": "object",
"examples": [
{
"verify": {
"preset": "github",
"secret": "example-secret"
},
"instance_id": "ipr_exampleexampleexample2",
"inbox_instance_id": "inb_exampleexampleexample2"
}
],
"required": [
"instance_id"
],
"properties": {
"verify": {
"anyOf": [
{
"type": "object",
"required": [
"preset",
"secret"
],
"properties": {
"header": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "hmac only: the signature header."
},
"prefix": {
"type": "string",
"maxLength": 20,
"description": "hmac only: text before the signature, for example \"sha256=\"."
},
"preset": {
"enum": [
"github",
"stripe",
"slack",
"zoom",
"hmac"
],
"type": "string",
"description": "The sender: github, stripe, slack or zoom, or hmac for any other sender that signs with HMAC."
},
"secret": {
"type": "string",
"maxLength": 256,
"minLength": 1,
"description": "The sender's signing secret (stored encrypted, never shown)."
},
"encoding": {
"enum": [
"hex",
"base64"
],
"type": "string",
"description": "hmac only, default hex."
},
"algorithm": {
"enum": [
"sha256",
"sha512",
"sha1"
],
"type": "string",
"description": "hmac only, default sha256."
},
"reject_unverified": {
"type": "boolean",
"description": "true: a message that fails is refused with 401 and not stored."
},
"forward_only_verified": {
"type": "boolean",
"description": "true: forward only messages whose signature verified; the rest stay in the inbox (forward status skipped, not_verified)."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Sender signature check; null turns it off."
},
"forward": {
"anyOf": [
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"description": "Public https URL."
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Where to forward every message; null turns it off."
},
"handshakes": {
"type": "object",
"properties": {
"zoom": {
"type": "boolean",
"description": "Answer Zoom's endpoint.url_validation (needs verify preset zoom)."
},
"slack": {
"type": "boolean",
"description": "Answer Slack's url_verification (needs verify preset slack)."
},
"meta_verify_token": {
"anyOf": [
{
"type": "string",
"maxLength": 256,
"minLength": 1
},
{
"type": "null"
}
],
"description": "Answer Meta's GET hub.challenge when hub.verify_token equals this (8 to 256 characters). null turns it off."
}
},
"description": "Answer the Slack, Zoom or Meta URL checks.",
"additionalProperties": false
},
"instance_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Utility instance id from buy or list_utilities."
},
"passport_token": {
"type": "string",
"maxLength": 200,
"description": "Your amp_ token, only if you have no app sign-in and cannot send a header."
},
"inbox_instance_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The inbox to upgrade (one of yours)."
},
"rotate_forward_secret": {
"type": "boolean",
"const": true,
"description": "true: a new forwarding key (returned once)."
}
},
"additionalProperties": false
}