Registration and Management

registering webhooks api endpoint post /webhooks/ register a new webhook endpoint to start receiving event notifications request parameters parameter type required description callback url string (url) yes your publicly accessible https endpoint that will receive webhook events must be unique per company callback api key string no optional api key that jetpay will include when calling your endpoint for additional authentication max batch size integer no maximum number of events to include in a single webhook delivery range 1 100 default 10 max wait seconds integer no maximum time (in seconds) to wait before sending a batch if max batch size isn't reached range 60 3600 default 60 replay from event id integer no replay all events starting from this event id (inclusive) useful for recovery or backfilling replay from timestamp string (iso 8601) no replay all events created at or after this timestamp alternative to replay from event id response fields field type description identifier string (uuid) unique identifier for managing this webhook (use in get/patch/delete operations) callback url string the registered webhook endpoint url state string current webhook state (initially active ) last sent event id integer id of the most recent event successfully delivered (null if none sent yet) max batch size integer configured maximum batch size max wait seconds integer configured maximum wait time unique url constraint each company can only register one webhook per unique url attempting to register a duplicate url will return a validation error if you need to update an existing webhook's configuration, use the patch endpoint instead example response { "identifier" "550e8400 e29b 41d4 a716 446655440000", "callback url" "https //your domain com/webhooks/jetpay", "callback api key" "yourapikey", "state" "active", "last sent event id" null, "max batch size" 10, "max wait seconds" 60, } managing webhooks you can view our detailed schema for all webhook related api requests https //extapi jetpay baselinepayments com/docs#tag/webhooks (v0) list all webhooks get /webhooks/ retrieve all webhook configurations for your company response array of webhook objects with all configuration fields retrieve a specific webhook get /webhooks/{identifier}/ retrieve details for a specific webhook using its identifier (uuid) path parameters identifier the uuid returned when the webhook was created response single webhook object with all configuration fields update a webhook patch /webhooks/{identifier}/ update configuration for an existing webhook path parameters identifier the uuid of the webhook to update request body include only the fields you want to update callback url callback api key max batch size max wait seconds replay from event id replay from timestamp response updated webhook object with all configuration fields note updating replay from event id or replay from timestamp will trigger replay of historical events starting from that point delete a webhook delete /webhooks/{identifier}/ permanently delete a webhook configuration event delivery will stop immediately path parameters identifier the uuid of the webhook to delete response http 204 no content on success warning deletion is permanent if you need to temporarily stop receiving events, consider using a different approach specific to your integration needs