Add a push configuration
Adds a push service to the project.
It starts disabled; save its settings and credentials with an update that enables it. A project has one configuration per push service.
Guide: Push notifications
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The push service: fcm for Firebase Cloud Messaging, apns for the Apple Push Notification service.
Value in
- "fcm"
- "apns"
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/push-notification-configurations" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "type": "apns" }'{ "id": "push_conf_m3n7b1v5c9x2z6l0k4j8h2g6", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "type": "apns", "name": "Apple Push Notification service", "key": null, "isEnabled": false, "configuration": { "teamId": "", "keyId": "", "bundleId": "", "environment": "production", "hasPrivateKey": false }, "createdAt": "2026-02-05T09:00:00.000Z", "updatedAt": "2026-02-05T09:00:00.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Missing key\n at [\"type\"]" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "conflict", "code": "push_notification_configuration_exists", "message": "This project already has a configuration for this push service; update that one.", "param": "type" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 409 | conflict | push_notification_configuration_exists | For another. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Push configurations
Something wrong or missing on this page? Tell us by email or on Discord.