Skip to main content
POST
/
webhooks
Create a new webhook
curl --request POST \
  --url https://api.lettermint.co/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "route_id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "events": [
    "message.created"
  ],
  "enabled": true
}
'
{
  "data": {
    "id": "<string>",
    "route_id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "enabled": true,
    "last_called_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  },
  "message": "Webhook created successfully. Please save the secret as it will not be shown again."
}

Authorizations

​
Authorization
string
header
required

Team API token. Find this in your team settings.

Body

application/json

StoreWebhookData

​
route_id
string
required
​
name
string
required
Maximum string length: 255
​
url
string<uri>
required
Maximum string length: 500
​
events
enum<string>[]
required
Minimum array length: 1
Available options:
message.created,
message.sent,
message.delivered,
message.hard_bounced,
message.soft_bounced,
message.spam_complaint,
message.failed,
message.suppressed,
message.unsubscribed,
message.opened,
message.clicked,
message.inbound,
message.policy_rejected,
webhook.test
​
enabled
boolean | null
default:true

Response

​
data
WebhookData · object
required
​
message
enum<string>
required
Available options:
Webhook created successfully. Please save the secret as it will not be shown again.