Webhook

Download schema

List all webhooks for the team

GET

https://api.lettermint.co/v1

/webhooks

Bearer

Returns a paginated list of webhooks with filtering options.

List all webhooks for the team › query Parameters

sort

string[]

Enum values:

name

-name

url

-url

created_at

-created_at

Default: ["-created_at"]

filter[project]

string

Filter by project ID

filter[enabled]

boolean

Filter by enabled status

filter[event]

WebhookEvent · enum

Filter by specific event type

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

filter[route_id]

string

Filter by route ID

filter[search]

string

Search by webhook name or URL

List all webhooks for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List all webhooks for the team › Responses

200

Paginated set of WebhookListData

WebhookListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Create a new webhook

POST

https://api.lettermint.co/v1

/webhooks

Bearer

Creates a webhook for a specific route and generates a secret for signature verification.

Create a new webhook › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Create a new webhook › Request Body

StoreWebhookData

route_id

string · required

name

string · maxLength: 255 · required

url

string · uri · maxLength: 500 · required

events

WebhookEvent[] · minItems: 1 · required

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

enabled

boolean | null

Default: true

include_machine_events

boolean | null

Default: false

Create a new webhook › Responses

WebhookData · required

message

string · const · required

Const value: Webhook created successfully. Please save the secret as it will not be shown again.

POST/webhooks

curl https://api.lettermint.co/v1/webhooks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "route_id": "route_id",
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": false
}'

Example Request Body

{
  "route_id": "route_id",
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": false
}

json

Example Responses

{
  "data": {
    "id": "id",
    "route_id": "route_id",
    "name": "name",
    "url": "url",
    "events": [
      "string"
    ],
    "enabled": true,
    "include_machine_events": true,
    "secret": "secret",
    "last_called_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "message": "Webhook created successfully. Please save the secret as it will not be shown again."
}

json

application/json

Get webhook details

GET

https://api.lettermint.co/v1

/webhooks/{webhookId}

Bearer

Returns full webhook information including recent deliveries.

Get webhook details › path Parameters

webhookId

string · required

Get webhook details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get webhook details › Responses

200

WebhookData

WebhookData

id

string · required

route_id

string · required

name

string · required

url

string · required

events

string[] · minItems: 1 · required

enabled

boolean · required

include_machine_events

boolean · required

last_called_at

string | null · date-time · required

created_at

string · date-time · required

updated_at

string · date-time · required

secret

string

Update webhook settings

PUT

https://api.lettermint.co/v1

/webhooks/{webhookId}

Bearer

Updates webhook configuration. Events, URL, name, and enabled status can be modified.

Update webhook settings › path Parameters

webhookId

string · required

Update webhook settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update webhook settings › Request Body

UpdateWebhookData

name

string · maxLength: 255

url

string · uri · maxLength: 500

events

WebhookEvent[] · minItems: 1

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

enabled

boolean

include_machine_events

boolean

Update webhook settings › Responses

WebhookData · required

message

string · const · required

Const value: Webhook updated successfully.

PUT/webhooks/{webhookId}

curl https://api.lettermint.co/v1/webhooks/:webhookId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": true
}'

Example Request Body

{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": true
}

json

Example Responses

{
  "data": {
    "id": "id",
    "route_id": "route_id",
    "name": "name",
    "url": "url",
    "events": [
      "string"
    ],
    "enabled": true,
    "include_machine_events": true,
    "secret": "secret",
    "last_called_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "message": "Webhook updated successfully."
}

json

application/json

Delete a webhook

DELETE

https://api.lettermint.co/v1

/webhooks/{webhookId}

Bearer

Permanently removes a webhook and all associated delivery records.

Delete a webhook › path Parameters

webhookId

string · required

Delete a webhook › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Delete a webhook › Responses

200

message

string · const · required

Const value: Webhook deleted successfully.

Test a webhook by sending a sample payload

POST

https://api.lettermint.co/v1

/webhooks/{webhookId}/test

Bearer

Dispatches a test webhook delivery to verify the endpoint is working correctly.

Test a webhook by sending a sample payload › path Parameters

webhookId

string · required

Test a webhook by sending a sample payload › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Test a webhook by sending a sample payload › Responses

200

message

string · const · required

Const value: Test webhook dispatched successfully. Check the deliveries endpoint for results.

delivery_id

string · required

Regenerate webhook secret

POST

https://api.lettermint.co/v1

/webhooks/{webhookId}/regenerate-secret

Bearer

Generates a new secret for webhook signature verification. The old secret will be invalidated.

Regenerate webhook secret › path Parameters

webhookId

string · required

Regenerate webhook secret › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Regenerate webhook secret › Responses

200

WebhookData · required

message

string · const · required

Const value: Webhook secret regenerated successfully. Please update your integration.

Get webhook deliveries

GET

https://api.lettermint.co/v1

/webhooks/{webhookId}/deliveries

Bearer

Returns a paginated list of delivery attempts for a specific webhook.

Get webhook deliveries › path Parameters

webhookId

string · required

Get webhook deliveries › query Parameters

sort

string[]

Enum values:

created_at

-created_at

attempt_number

-attempt_number

Default: ["-created_at"]

filter[status]

WebhookDeliveryStatus · enum

Filter by delivery status

Enum values:

pending

success

failed

client_error

server_error

timeout

filter[event_type]

string

Filter by event type

filter[from_date]

string

Filter deliveries from this date (Y-m-d format)

filter[to_date]

string

Filter deliveries to this date (Y-m-d format)

Get webhook deliveries › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get webhook deliveries › Responses

200

Paginated set of WebhookDeliveryListData

WebhookDeliveryListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Get a specific webhook delivery

GET

https://api.lettermint.co/v1

/webhooks/{webhookId}/deliveries/{deliveryId}

Bearer

Returns full details of a single delivery attempt including payload and response data.

Get a specific webhook delivery › path Parameters

webhookId

string · required

deliveryId

string · required

Get a specific webhook delivery › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get a specific webhook delivery › Responses

200

WebhookDeliveryData

WebhookDeliveryData

id

string · required

webhook_id

string · required

event_type

WebhookEvent · enum · required

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

status

WebhookDeliveryStatus · enum · required

Enum values:

pending

success

failed

client_error

server_error

timeout

attempt_number

integer · required

http_status_code

integer | null · required

duration_ms

integer | null · required

payload

string[] · minItems: 1 · required

response_body

string | null · required

response_headers

array | null · required

error_message

string | null · required

delivered_at

string | null · date-time · required

timestamp

string · date-time · required

Project Message

Lettermint Team API

Webhook

Download schema

List all webhooks for the team

GET

https://api.lettermint.co/v1

/webhooks

Bearer

Returns a paginated list of webhooks with filtering options.

List all webhooks for the team › query Parameters

sort

string[]

Enum values:

name

-name

url

-url

created_at

-created_at

Default: ["-created_at"]

filter[project]

string

Filter by project ID

filter[enabled]

boolean

Filter by enabled status

filter[event]

WebhookEvent · enum

Filter by specific event type

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

filter[route_id]

string

Filter by route ID

filter[search]

string

Search by webhook name or URL

List all webhooks for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List all webhooks for the team › Responses

200

Paginated set of WebhookListData

WebhookListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Create a new webhook

POST

https://api.lettermint.co/v1

/webhooks

Bearer

Creates a webhook for a specific route and generates a secret for signature verification.

Create a new webhook › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Create a new webhook › Request Body

StoreWebhookData

route_id

string · required

name

string · maxLength: 255 · required

url

string · uri · maxLength: 500 · required

events

WebhookEvent[] · minItems: 1 · required

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

enabled

boolean | null

Default: true

include_machine_events

boolean | null

Default: false

Create a new webhook › Responses

WebhookData · required

message

string · const · required

Const value: Webhook created successfully. Please save the secret as it will not be shown again.

POST/webhooks

curl https://api.lettermint.co/v1/webhooks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "route_id": "route_id",
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": false
}'

Example Request Body

{
  "route_id": "route_id",
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": false
}

json

Example Responses

{
  "data": {
    "id": "id",
    "route_id": "route_id",
    "name": "name",
    "url": "url",
    "events": [
      "string"
    ],
    "enabled": true,
    "include_machine_events": true,
    "secret": "secret",
    "last_called_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "message": "Webhook created successfully. Please save the secret as it will not be shown again."
}

json

application/json

Get webhook details

GET

https://api.lettermint.co/v1

/webhooks/{webhookId}

Bearer

Returns full webhook information including recent deliveries.

Get webhook details › path Parameters

webhookId

string · required

Get webhook details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get webhook details › Responses

200

WebhookData

WebhookData

id

string · required

route_id

string · required

name

string · required

url

string · required

events

string[] · minItems: 1 · required

enabled

boolean · required

include_machine_events

boolean · required

last_called_at

string | null · date-time · required

created_at

string · date-time · required

updated_at

string · date-time · required

secret

string

Update webhook settings

PUT

https://api.lettermint.co/v1

/webhooks/{webhookId}

Bearer

Updates webhook configuration. Events, URL, name, and enabled status can be modified.

Update webhook settings › path Parameters

webhookId

string · required

Update webhook settings › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Update webhook settings › Request Body

UpdateWebhookData

name

string · maxLength: 255

url

string · uri · maxLength: 500

events

WebhookEvent[] · minItems: 1

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

enabled

boolean

include_machine_events

boolean

Update webhook settings › Responses

WebhookData · required

message

string · const · required

Const value: Webhook updated successfully.

PUT/webhooks/{webhookId}

curl https://api.lettermint.co/v1/webhooks/:webhookId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": true
}'

Example Request Body

{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "events": [
    "message.created"
  ],
  "enabled": true,
  "include_machine_events": true
}

json

Example Responses

{
  "data": {
    "id": "id",
    "route_id": "route_id",
    "name": "name",
    "url": "url",
    "events": [
      "string"
    ],
    "enabled": true,
    "include_machine_events": true,
    "secret": "secret",
    "last_called_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  },
  "message": "Webhook updated successfully."
}

json

application/json

Delete a webhook

DELETE

https://api.lettermint.co/v1

/webhooks/{webhookId}

Bearer

Permanently removes a webhook and all associated delivery records.

Delete a webhook › path Parameters

webhookId

string · required

Delete a webhook › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Delete a webhook › Responses

200

message

string · const · required

Const value: Webhook deleted successfully.

Test a webhook by sending a sample payload

POST

https://api.lettermint.co/v1

/webhooks/{webhookId}/test

Bearer

Dispatches a test webhook delivery to verify the endpoint is working correctly.

Test a webhook by sending a sample payload › path Parameters

webhookId

string · required

Test a webhook by sending a sample payload › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Test a webhook by sending a sample payload › Responses

200

message

string · const · required

Const value: Test webhook dispatched successfully. Check the deliveries endpoint for results.

delivery_id

string · required

Regenerate webhook secret

POST

https://api.lettermint.co/v1

/webhooks/{webhookId}/regenerate-secret

Bearer

Generates a new secret for webhook signature verification. The old secret will be invalidated.

Regenerate webhook secret › path Parameters

webhookId

string · required

Regenerate webhook secret › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Regenerate webhook secret › Responses

200

WebhookData · required

message

string · const · required

Const value: Webhook secret regenerated successfully. Please update your integration.

Get webhook deliveries

GET

https://api.lettermint.co/v1

/webhooks/{webhookId}/deliveries

Bearer

Returns a paginated list of delivery attempts for a specific webhook.

Get webhook deliveries › path Parameters

webhookId

string · required

Get webhook deliveries › query Parameters

sort

string[]

Enum values:

created_at

-created_at

attempt_number

-attempt_number

Default: ["-created_at"]

filter[status]

WebhookDeliveryStatus · enum

Filter by delivery status

Enum values:

pending

success

failed

client_error

server_error

timeout

filter[event_type]

string

Filter by event type

filter[from_date]

string

Filter deliveries from this date (Y-m-d format)

filter[to_date]

string

Filter deliveries to this date (Y-m-d format)

Get webhook deliveries › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get webhook deliveries › Responses

200

Paginated set of WebhookDeliveryListData

WebhookDeliveryListData[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

next_cursor

string | null · required

The "cursor" that points to the next set of items.

next_page_url

string | null · uri · required

prev_cursor

string | null · required

The "cursor" that points to the previous set of items.

prev_page_url

string | null · uri · required

Get a specific webhook delivery

GET

https://api.lettermint.co/v1

/webhooks/{webhookId}/deliveries/{deliveryId}

Bearer

Returns full details of a single delivery attempt including payload and response data.

Get a specific webhook delivery › path Parameters

webhookId

string · required

deliveryId

string · required

Get a specific webhook delivery › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get a specific webhook delivery › Responses

200

WebhookDeliveryData

WebhookDeliveryData

id

string · required

webhook_id

string · required

event_type

WebhookEvent · enum · required

Enum values:

message.created

message.sent

message.delivered

message.auto_replied

message.hard_bounced

message.soft_bounced

message.spam_complaint

message.failed

status

WebhookDeliveryStatus · enum · required

Enum values:

pending

success

failed

client_error

server_error

timeout

attempt_number

integer · required

http_status_code

integer | null · required

duration_ms

integer | null · required

payload

string[] · minItems: 1 · required

response_body

string | null · required

response_headers

array | null · required

error_message

string | null · required

delivered_at

string | null · date-time · required

timestamp

string · date-time · required

Project Message