Create Webhook

POST 
https://api.rapidcompact.com/api/v1/user/webhooks

Request

Header Parameters

Authorization string
Example: Bearer {YOUR_AUTH_KEY}
Content-Type string
Example: application/json
Accept string
Example: application/json

application/json

Body

required

url stringrequired

The url of the webhook

secret string

A secret to be sent in the header of webhook requests

verify_ssl booleanrequired

Whether to verify ssl or not

Responses

200

success

application/json

Schema

Schema

id integer
user_id integer
url string
last_called_at string
created_at string
updated_at string
secret string
last_status string
verify_ssl boolean
failed_calls integer
notified_at string

Example (from schema)

{
  "id": 6,
  "user_id": 303,
  "url": "https://example.com/webhook",
  "last_called_at": "2021-10-26T09:45:47.000000Z",
  "created_at": "2021-10-26T09:45:47.000000Z",
  "updated_at": "2021-10-26T09:45:47.000000Z",
  "secret": "aut",
  "last_status": null,
  "verify_ssl": true,
  "failed_calls": 0,
  "notified_at": null
}

500

Maximum number of tags reached

text/plain

Schema

Schema

string

Authorization: http

name: defaulttype: httpscheme: bearerdescription: 

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.rapidcompact.com/api/v1/user/webhooks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "url": "https://example.com/webhook",
  "secret": "my secret",
  "verify_ssl": false
}'

Request Collapse all

Base URL

https://api.rapidcompact.com

Auth

Bearer Token

Parameters

Authorization — header

Content-Type — header

Accept — header

Body required

{
  "url": "https://example.com/webhook",
  "secret": "my secret",
  "verify_ssl": false
}

ResponseClear

Click the Send API Request button above and see the response here!