Update webhook endpoint
curl --request PATCH \
--url https://sg.sandbox.api.reap.global/webhooks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Reap-Version: <reap-version>' \
--data '
{
"name": "<string>",
"url": "<string>"
}
'const options = {
method: 'PATCH',
headers: {
'Reap-Version': '<reap-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', url: '<string>'})
};
fetch('https://sg.sandbox.api.reap.global/webhooks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sg.sandbox.api.reap.global/webhooks/{id}"
payload = {
"name": "<string>",
"url": "<string>"
}
headers = {
"Reap-Version": "<reap-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"status": "ACTIVE",
"mode": "NOTIFICATION",
"lastUsedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "INVALID_WEBHOOK_URL",
"message": "<string>",
"detail": {}
}
}{
"error": {
"code": "WEBHOOK_NOT_FOUND",
"message": "<string>",
"detail": {}
}
}Webhooks
Update webhook endpoint
Update mutable fields (name, url). To rotate the signing secret, use POST /:id/rotate-secret. To disable, use POST /:id/disable.
PATCH
/
webhooks
/
{id}
Update webhook endpoint
curl --request PATCH \
--url https://sg.sandbox.api.reap.global/webhooks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Reap-Version: <reap-version>' \
--data '
{
"name": "<string>",
"url": "<string>"
}
'const options = {
method: 'PATCH',
headers: {
'Reap-Version': '<reap-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', url: '<string>'})
};
fetch('https://sg.sandbox.api.reap.global/webhooks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sg.sandbox.api.reap.global/webhooks/{id}"
payload = {
"name": "<string>",
"url": "<string>"
}
headers = {
"Reap-Version": "<reap-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"status": "ACTIVE",
"mode": "NOTIFICATION",
"lastUsedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "INVALID_WEBHOOK_URL",
"message": "<string>",
"detail": {}
}
}{
"error": {
"code": "WEBHOOK_NOT_FOUND",
"message": "<string>",
"detail": {}
}
}Authorizations
API key as Bearer token
Headers
API version (YYYY-MM-DD)
Available options:
2025-02-14 Example:
"2025-02-14"
Path Parameters
Webhook ID
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Webhook endpoint configuration. The signing secret is never included in this response; it is only returned once at create and at rotate-secret time.
Unique webhook identifier
Human-readable label
HTTPS endpoint that receives signed POSTs
Lifecycle status. Disabled webhooks receive no deliveries.
Available options:
ACTIVE, DISABLED Example:
"ACTIVE"
Interaction pattern of the endpoint.
Available options:
NOTIFICATION, REQUEST Example:
"NOTIFICATION"
Timestamp of the most recent successful delivery
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ISO 8601 creation timestamp
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ISO 8601 last update timestamp
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$