Register a new webhook endpoint
Returns the endpoint metadata + a one-time `signingSecret`. Store the secret immediately; subsequent reads do not include it. Free tier allows 1 endpoint, Pro 10, Org 100; the cap returns 402 with an `upgrade_required` payload.
Returns the endpoint metadata + a one-time signingSecret. Store the secret immediately; subsequent reads do not include it. Free tier allows 1 endpoint, Pro 10, Org 100; the cap returns 402 with an upgrade_required payload.
Authorization
ApiKey Long-lived org-scoped API key. Generate one from your account dashboard. Pass as Authorization: Bearer sgn_live_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "https://hooks.example.com/thesignup" }'{
"endpoint": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "http://example.com",
"description": "string",
"eventTypes": [
"signup.created"
],
"paused": true,
"pausedReason": "string",
"pausedAt": "2019-08-24T14:15:22Z",
"consecutiveFailures": 0,
"lastSuccessAt": "2019-08-24T14:15:22Z",
"lastFailureAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"signingSecret": "whsec_AbCdEf..."
}{
"type": "https://thesignup.app/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "string",
"code": "missing_credentials",
"errors": [
{
"path": "string",
"message": "string"
}
],
"cause": {
"property1": null,
"property2": null
}
}{
"type": "https://thesignup.app/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "string",
"code": "missing_credentials",
"errors": [
{
"path": "string",
"message": "string"
}
],
"cause": {
"property1": null,
"property2": null
}
}{
"type": "https://thesignup.app/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "string",
"code": "missing_credentials",
"errors": [
{
"path": "string",
"message": "string"
}
],
"cause": {
"property1": null,
"property2": null
}
}{
"type": "https://thesignup.app/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "string",
"code": "missing_credentials",
"errors": [
{
"path": "string",
"message": "string"
}
],
"cause": {
"property1": null,
"property2": null
}
}{
"type": "https://thesignup.app/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "string",
"code": "missing_credentials",
"errors": [
{
"path": "string",
"message": "string"
}
],
"cause": {
"property1": null,
"property2": null
}
}{
"type": "https://thesignup.app/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "string",
"code": "missing_credentials",
"errors": [
{
"path": "string",
"message": "string"
}
],
"cause": {
"property1": null,
"property2": null
}
}