API ReferenceWebhooks
Create a webhook
Registers an HTTPS endpoint to receive event POSTs. The response includes the signing secret (whsec_...) — verify each delivery via the X-Nimply-Signature header (HMAC-SHA256 over "."). Deliveries are retried 5 times with exponential backoff; after 10 consecutively failed deliveries the endpoint is auto-disabled.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "name": "Zapier trigger", "url": "https://example.com/hooks/nimply", "events": [ "post.published", "post.failed" ] }'{ "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Zapier trigger", "url": "https://example.com/hooks/nimply", "secret": "whsec_...", "events": [ "post.published", "post.failed" ], "isActive": true, "failureCount": 0, "lastSuccessAt": {}, "lastFailureAt": {}, "createdAt": "2019-08-24T14:15:22Z"}