Webhooks
Update webhook subscription
Updates the notification URL, subscribed event types, or enabled/disabled status. The signing secret is unchanged.
Update webhook subscription
curl --request PATCH \
--url https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"notification_url": "<string>",
"event_types": [
"<string>"
]
}
'import requests
url = "https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}"
payload = {
"notification_url": "<string>",
"event_types": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({notification_url: '<string>', event_types: ['<string>']})
};
fetch('https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}', 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://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'notification_url' => '<string>',
'event_types' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}"
payload := strings.NewReader("{\n \"notification_url\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notification_url\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"notification_url\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"object": "webhook_subscription",
"id": "<string>",
"notification_url": "<string>",
"event_types": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>"
}{
"_tag": "DeveloperApiBadRequest",
"message": "<string>"
}{
"_tag": "DeveloperApiUnauthorized",
"message": "<string>"
}{
"_tag": "DeveloperApiForbidden",
"message": "<string>"
}{
"_tag": "DeveloperApiNotFound",
"message": "<string>"
}Authorizations
API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.
Path Parameters
Body
application/json
Response
Success
Available options:
webhook_subscription Available options:
test, live Available options:
enabled, disabled Was this page helpful?
Previous
Send test webhookDelivers a synthetic `webhook.test` event to the subscription and returns the delivery result.
Next
⌘I
Update webhook subscription
curl --request PATCH \
--url https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"notification_url": "<string>",
"event_types": [
"<string>"
]
}
'import requests
url = "https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}"
payload = {
"notification_url": "<string>",
"event_types": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({notification_url: '<string>', event_types: ['<string>']})
};
fetch('https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}', 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://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'notification_url' => '<string>',
'event_types' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}"
payload := strings.NewReader("{\n \"notification_url\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notification_url\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"notification_url\": \"<string>\",\n \"event_types\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"object": "webhook_subscription",
"id": "<string>",
"notification_url": "<string>",
"event_types": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>"
}{
"_tag": "DeveloperApiBadRequest",
"message": "<string>"
}{
"_tag": "DeveloperApiUnauthorized",
"message": "<string>"
}{
"_tag": "DeveloperApiForbidden",
"message": "<string>"
}{
"_tag": "DeveloperApiNotFound",
"message": "<string>"
}