Skip to main content
Create a webhook
curl --request POST \
  --url https://app.simpledocs.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Salesforce Integration",
  "url": "https://example.com/webhooks/simpledocs",
  "auth_type": "no_auth",
  "username": "<string>",
  "password": "<string>",
  "token": "<string>"
}
'
import requests

url = "https://app.simpledocs.com/api/v1/webhooks"

payload = {
    "name": "Salesforce Integration",
    "url": "https://example.com/webhooks/simpledocs",
    "auth_type": "no_auth",
    "username": "<string>",
    "password": "<string>",
    "token": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Salesforce Integration',
    url: 'https://example.com/webhooks/simpledocs',
    auth_type: 'no_auth',
    username: '<string>',
    password: '<string>',
    token: '<string>'
  })
};

fetch('https://app.simpledocs.com/api/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{ "data": { "id": "<string>", "type": "webhook", "attributes": { "name": "Salesforce Integration", "url": "https://example.com/webhooks/simpledocs", "auth_type": "bearer", "events": [ "execution_complete" ] } } }

Authorizations

Authorization
string
header
required

Obtain a Bearer token via the Create access token endpoint using the OAuth2 client credentials flow.

Body

application/json
name
string
required

A human-readable name for the webhook.

Example:

"Salesforce Integration"

url
string<uri>
required

The HTTPS URL that will receive webhook payloads.

Example:

"https://example.com/webhooks/simpledocs"

auth_type
enum<string>
default:no_auth

The authentication method for webhook delivery.

Available options:
no_auth,
basic,
bearer
username
string

Username for basic authentication.

password
string

Password for basic authentication.

token
string

Bearer token for bearer authentication.

Response

Webhook created successfully.

data
object