Webhooks
A webhook sends a signed POST to your server when something changes in your fund. Use it to keep your own tools up to date without polling.
List webhooks
The webhooks of your fund and the events that each one gets.
Example request
curl https://www.ideapulley.com/api/v2/webhooks \
-H "Authorization: Bearer $IDEAPULLEY_KEY"const res = await fetch("https://www.ideapulley.com/api/v2/webhooks", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IDEAPULLEY_KEY}`,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://www.ideapulley.com/api/v2/webhooks",
headers={"Authorization": f"Bearer {os.environ['IDEAPULLEY_KEY']}"},
)
data = res.json()Response
{
"data": [
{
"id": 7,
"url": "https://example.com/hooks/ideapulley",
"events": [
"deal.created",
"deal.chance_changed"
],
"enabled": true,
"createdAt": 1793577600
}
]
}Add a webhook
Add an HTTPS address that gets events. The response has the signing secret. You see the secret one time only.
Body parameters
| Name | Type |
|---|---|
urlRequiredThe HTTPS address that gets the events. Up to 2,048 characters. | string |
eventsThe events to send, up to 50. Default ["*"]: all events. | string[] |
Example request
curl -X POST https://www.ideapulley.com/api/v2/webhooks \
-H "Authorization: Bearer $IDEAPULLEY_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/hooks/ideapulley","events":["deal.created","deal.chance_changed"]}'const res = await fetch("https://www.ideapulley.com/api/v2/webhooks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IDEAPULLEY_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"url": "https://example.com/hooks/ideapulley",
"events": [
"deal.created",
"deal.chance_changed"
]
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://www.ideapulley.com/api/v2/webhooks",
headers={"Authorization": f"Bearer {os.environ['IDEAPULLEY_KEY']}"},
json={
"url": "https://example.com/hooks/ideapulley",
"events": [
"deal.created",
"deal.chance_changed"
]
},
)
data = res.json()Response
{
"id": 7,
"url": "https://example.com/hooks/ideapulley",
"events": [
"deal.created",
"deal.chance_changed"
],
"secret": "whsec_9f2c…"
}Get a webhook
One webhook. The secret is not in the response.
Path parameters
| Name | Type |
|---|---|
idRequiredThe webhook ID. | integer |
Example request
curl https://www.ideapulley.com/api/v2/webhooks/7 \
-H "Authorization: Bearer $IDEAPULLEY_KEY"const res = await fetch("https://www.ideapulley.com/api/v2/webhooks/7", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IDEAPULLEY_KEY}`,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://www.ideapulley.com/api/v2/webhooks/7",
headers={"Authorization": f"Bearer {os.environ['IDEAPULLEY_KEY']}"},
)
data = res.json()Response
{
"data": {
"id": 7,
"url": "https://example.com/hooks/ideapulley",
"events": [
"deal.created",
"deal.chance_changed"
],
"enabled": true,
"createdAt": 1793577600
}
}Delete a webhook
Delete a webhook. Events stop at once.
Path parameters
| Name | Type |
|---|---|
idRequiredThe webhook ID. | integer |
Example request
curl -X DELETE https://www.ideapulley.com/api/v2/webhooks/7 \
-H "Authorization: Bearer $IDEAPULLEY_KEY"const res = await fetch("https://www.ideapulley.com/api/v2/webhooks/7", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.IDEAPULLEY_KEY}`,
},
});
const data = await res.json();import os
import requests
res = requests.delete(
"https://www.ideapulley.com/api/v2/webhooks/7",
headers={"Authorization": f"Bearer {os.environ['IDEAPULLEY_KEY']}"},
)
data = res.json()Response
{
"data": {
"id": 7,
"deleted": true
}
}Send a test event
Send a signed webhook.test event to the webhook now, and get the status that your server sent back.
Path parameters
| Name | Type |
|---|---|
idRequiredThe webhook ID. | integer |
Example request
curl -X POST https://www.ideapulley.com/api/v2/webhooks/7/test \
-H "Authorization: Bearer $IDEAPULLEY_KEY"const res = await fetch("https://www.ideapulley.com/api/v2/webhooks/7/test", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.IDEAPULLEY_KEY}`,
},
});
const data = await res.json();import os
import requests
res = requests.post(
"https://www.ideapulley.com/api/v2/webhooks/7/test",
headers={"Authorization": f"Bearer {os.environ['IDEAPULLEY_KEY']}"},
)
data = res.json()Response
{
"data": {
"delivered": true,
"statusCode": 200,
"error": null
}
}List deliveries
The recent deliveries of a webhook, with the status that your server sent back. Use it to find failed deliveries.
Path parameters
| Name | Type |
|---|---|
idRequiredThe webhook ID. | integer |
Query parameters
| Name | Type |
|---|---|
limitRows to return, up to 200. Default 50. | integer |
Example request
curl https://www.ideapulley.com/api/v2/webhooks/7/deliveries \
-H "Authorization: Bearer $IDEAPULLEY_KEY"const res = await fetch("https://www.ideapulley.com/api/v2/webhooks/7/deliveries", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.IDEAPULLEY_KEY}`,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://www.ideapulley.com/api/v2/webhooks/7/deliveries",
headers={"Authorization": f"Bearer {os.environ['IDEAPULLEY_KEY']}"},
)
data = res.json()Response
{
"data": [
{
"id": 301,
"eventId": "evt_c0a8…",
"statusCode": 200,
"responseBody": "ok",
"errorMessage": null,
"attemptedAt": 1793577660,
"nextRetryAt": null
}
]
}