Update the workspace's first webhook endpoint.

curl --request PUT \
  --url https://dash.dmly.io/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://hooks.example.com/dmly/incoming",
  "events": [
    "contact.created",
    "booking.created",
    "invoice.paid"
  ],
  "channel": "all",
  "secret": "whsec_my_own_signing_secret_optional"
}
'

import requests

url = "https://dash.dmly.io/api/v1/webhooks"

payload = {
    "url": "https://hooks.example.com/dmly/incoming",
    "events": ["contact.created", "booking.created", "invoice.paid"],
    "channel": "all",
    "secret": "whsec_my_own_signing_secret_optional"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://hooks.example.com/dmly/incoming',
    events: ['contact.created', 'booking.created', 'invoice.paid'],
    channel: 'all',
    secret: 'whsec_my_own_signing_secret_optional'
  })
};

fetch('https://dash.dmly.io/api/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dash.dmly.io/api/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.example.com/dmly/incoming',
    'events' => [
        'contact.created',
        'booking.created',
        'invoice.paid'
    ],
    'channel' => 'all',
    'secret' => 'whsec_my_own_signing_secret_optional'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dash.dmly.io/api/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.example.com/dmly/incoming\",\n  \"events\": [\n    \"contact.created\",\n    \"booking.created\",\n    \"invoice.paid\"\n  ],\n  \"channel\": \"all\",\n  \"secret\": \"whsec_my_own_signing_secret_optional\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://dash.dmly.io/api/v1/webhooks")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.example.com/dmly/incoming\",\n  \"events\": [\n    \"contact.created\",\n    \"booking.created\",\n    \"invoice.paid\"\n  ],\n  \"channel\": \"all\",\n  \"secret\": \"whsec_my_own_signing_secret_optional\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dash.dmly.io/api/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.example.com/dmly/incoming\",\n  \"events\": [\n    \"contact.created\",\n    \"booking.created\",\n    \"invoice.paid\"\n  ],\n  \"channel\": \"all\",\n  \"secret\": \"whsec_my_own_signing_secret_optional\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

{
  "message": "<string>"
}

Update the workspace's first webhook endpoint.

Saves the workspace’s FIRST outbound webhook endpoint and marks it connected. It overwrites that endpoint’s URL, events, channel scope and secret rather than registering an additional endpoint, so it can silently replace an endpoint someone configured in the dashboard. To run more than one endpoint, manage them under Configurations → Integrations → Webhooks instead. url (alias endpoint) must be a public https URL — private/internal/unreachable hosts are rejected with 422. events must be a non-empty array of topics from the catalogue (GET /webhooks/events); unknown topics are rejected with 422 and message-lifecycle events the selected channel cannot deliver are silently dropped (if every submitted event is dropped the request 422s). channel scopes message events to a single channel (default “all”). A signing secret is generated automatically on first connect and preserved on subsequent updates unless you pass a new secret. Use the secret to verify the signature on delivered payloads. Returns the saved subscription (without the secret value).

PUT

webhooks

curl --request PUT \
  --url https://dash.dmly.io/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://hooks.example.com/dmly/incoming",
  "events": [
    "contact.created",
    "booking.created",
    "invoice.paid"
  ],
  "channel": "all",
  "secret": "whsec_my_own_signing_secret_optional"
}
'

import requests

url = "https://dash.dmly.io/api/v1/webhooks"

payload = {
    "url": "https://hooks.example.com/dmly/incoming",
    "events": ["contact.created", "booking.created", "invoice.paid"],
    "channel": "all",
    "secret": "whsec_my_own_signing_secret_optional"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://hooks.example.com/dmly/incoming',
    events: ['contact.created', 'booking.created', 'invoice.paid'],
    channel: 'all',
    secret: 'whsec_my_own_signing_secret_optional'
  })
};

fetch('https://dash.dmly.io/api/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dash.dmly.io/api/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://hooks.example.com/dmly/incoming',
    'events' => [
        'contact.created',
        'booking.created',
        'invoice.paid'
    ],
    'channel' => 'all',
    'secret' => 'whsec_my_own_signing_secret_optional'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dash.dmly.io/api/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://hooks.example.com/dmly/incoming\",\n  \"events\": [\n    \"contact.created\",\n    \"booking.created\",\n    \"invoice.paid\"\n  ],\n  \"channel\": \"all\",\n  \"secret\": \"whsec_my_own_signing_secret_optional\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://dash.dmly.io/api/v1/webhooks")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://hooks.example.com/dmly/incoming\",\n  \"events\": [\n    \"contact.created\",\n    \"booking.created\",\n    \"invoice.paid\"\n  ],\n  \"channel\": \"all\",\n  \"secret\": \"whsec_my_own_signing_secret_optional\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dash.dmly.io/api/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://hooks.example.com/dmly/incoming\",\n  \"events\": [\n    \"contact.created\",\n    \"booking.created\",\n    \"invoice.paid\"\n  ],\n  \"channel\": \"all\",\n  \"secret\": \"whsec_my_own_signing_secret_optional\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

{
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

Your workspace API key. It both authenticates the caller and selects the workspace.

Body

application/json

url

string<uri>

events

string[]

channel

string

secret

string

Response

Success.

Getting started

Endpoints

Webhook events

Update the workspace's first webhook endpoint.

Authorizations

Body

Response