API REFERENCE

Webhooks API

The SimplyRCS webhooks API has 6 public endpoints. Every endpoint below is documented with its parameters, responses and an example request. The reference is public and needs no account; a scoped API key is required only to make live calls.

Webhook endpoint management and provider callbacks.

Base URL https://api.simplyrcs.com · All 195 endpoints · Pricing

Endpoints in this section

GET /v1/webhook-endpoints
POST /v1/webhook-endpoints
PATCH /v1/webhook-endpoints/{id}
DELETE /v1/webhook-endpoints/{id}
POST /v1/webhook-endpoints/{id}/test
GET /v1/webhook-endpoints/{id}/deliveries

GET/v1/webhook-endpoints

List webhook endpoints

GET https://api.simplyrcs.com/v1/webhook-endpoints · requires an API key

Responses

Status	Returns	Description
`200`	`ListWebhookEndpointsResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/webhook-endpoints \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/webhook-endpoints

Create a webhook endpoint

POST https://api.simplyrcs.com/v1/webhook-endpoints · requires an API key

Request body

CreateWebhookEndpointBody · optional

Responses

Status	Returns	Description
`201`	`CreateWebhookEndpointResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/webhook-endpoints \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "https://example.com/webhooks/rcs", "events": ["message.received"] }'

PATCH/v1/webhook-endpoints/{id}

Update a webhook endpoint

PATCH https://api.simplyrcs.com/v1/webhook-endpoints/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

UpdateWebhookEndpointBody · optional

Responses

Status	Returns	Description
`200`	`object`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X PATCH https://api.simplyrcs.com/v1/webhook-endpoints/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "https://example.com/webhooks/rcs", "events": ["message.received"] }'

DELETE/v1/webhook-endpoints/{id}

Delete a webhook endpoint

DELETE https://api.simplyrcs.com/v1/webhook-endpoints/{id} · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Responses

Status	Returns	Description
`200`	`object`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X DELETE https://api.simplyrcs.com/v1/webhook-endpoints/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/webhook-endpoints/{id}/test

Send a test webhook delivery

POST https://api.simplyrcs.com/v1/webhook-endpoints/{id}/test · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Request body

TestWebhookBody · optional

Responses

Status	Returns	Description
`200`	`object`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X POST https://api.simplyrcs.com/v1/webhook-endpoints/{id}/test \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "https://example.com/webhooks/rcs", "events": ["message.received"] }'

GET/v1/webhook-endpoints/{id}/deliveries

List webhook delivery attempts

GET https://api.simplyrcs.com/v1/webhook-endpoints/{id}/deliveries · requires an API key

Path parameters

Name	Type	Description
`id` required	`Id`

Query parameters

Name	Type	Required	Description
`page`	`integer`	No
`limit`	`integer`	No

Responses

Status	Returns	Description
`200`	`ListWebhookDeliveriesResponse`	Successful response
`400`	`ErrorResponse`	Validation error
`401`	`ErrorResponse`	Authentication failed

Example request

curl -X GET https://api.simplyrcs.com/v1/webhook-endpoints/{id}/deliveries \
  -H 'Authorization: Bearer YOUR_API_KEY'

Other parts of the API

Get a free sender ID test Read the RCS API guide