Create a key to copy examples filled with your team.
Webhooks
Outbound delivery webhook endpoints.
Outbound delivery webhooks. The signing secret is returned on create and show, not on index. We POST a SendGrid Event Webhook array. Unique args you set at send time are flattened onto each event and also appear as unique_args.
GET /api/v1/teams/:team_id/webhook_endpoints
List webhook endpoints. secret is omitted.
request.sh
1
curl -sS -X GET \
2
-H 'Authorization: Bearer YOUR_API_KEY' \
3
https://postshiba.com/api/v1/teams/1/webhook_endpoints
response.json
1
[
2
{
3
"id": 2,
4
"url": "https://hooks.example.com/capsule",
5
"enabled": true,
6
"event_types": [
7
"processed",
8
"dropped",
9
"deferred",
10
"bounce",
11
"delivered",
12
"spamreport"
13
],
14
"last_success_at": null,
15
"last_failure_at": null,
16
"consecutive_failures": 0
17
}
18
]
GET /api/v1/webhook_endpoints/:id
Get one endpoint, including the signing secret.
id: Webhook endpoint id
request.sh
1
curl -sS -X GET \
2
-H 'Authorization: Bearer YOUR_API_KEY' \
3
https://postshiba.com/api/v1/webhook_endpoints/:webhook_endpoint_id
response.json
1
{
2
"id": 2,
3
"url": "https://hooks.example.com/capsule",
4
"enabled": true,
5
"event_types": [
6
"processed",
7
"dropped",
8
"deferred",
9
"bounce",
10
"delivered",
11
"spamreport"
12
],
13
"last_success_at": null,
14
"last_failure_at": null,
15
"consecutive_failures": 0,
16
"secret": "hex-secret"
17
}
POST /api/v1/teams/:team_id/webhook_endpoints
Create an endpoint. Optional event_types. Defaults to the SendGrid delivery set.
request.sh
1
curl -sS -X POST \
2
-H 'Authorization: Bearer YOUR_API_KEY' \
3
-H 'Content-Type: application/json' \
4
-d '{"webhook_endpoint":{"url":"https://hooks.example.com/capsule","event_types":["delivered","bounce"]}}' \
5
https://postshiba.com/api/v1/teams/1/webhook_endpoints
response.json
1
{
2
"id": 2,
3
"url": "https://hooks.example.com/capsule",
4
"enabled": true,
5
"event_types": [
6
"processed",
7
"dropped",
8
"deferred",
9
"bounce",
10
"delivered",
11
"spamreport"
12
],
13
"last_success_at": null,
14
"last_failure_at": null,
15
"consecutive_failures": 0,
16
"secret": "hex-secret"
17
}