Skip to main content

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

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

success

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

Authorization: http

name: defaulttype: httpscheme: bearerdescription: 
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
Parameters
— header
— header
— 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!