Skip to main content
POST
/
tools
Create tool
curl --request POST \
  --url https://api.goyappr.com/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Capture Lead",
  "type": "webhook",
  "config": {
    "url": "<string>",
    "method": "POST",
    "headers": {},
    "payload_config": {
      "include_standard_metadata": true,
      "static_parameters": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ],
      "extraction_parameters": [
        {
          "name": "callerName",
          "description": "The caller's full name"
        }
      ]
    }
  },
  "description": "<string>",
  "idempotency_key": "<string>"
}
EOF
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "type": "webhook",
  "config": {},
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
name
string
required
Example:

"Capture Lead"

type
enum<string>
required
Available options:
webhook
config
object
required
description
string
idempotency_key
string

Response

201 - application/json

Tool created

id
string<uuid>
name
string
description
string | null
type
enum<string>
Available options:
webhook,
system
config
object
is_active
boolean
created_at
string<date-time>