Skip to main content

The VidApp API: customers, product access and webhooks

Support
  • Updated

The VidApp API lets you connect your own systems to your app: create and manage customers, grant product access, and receive webhooks when subscriptions change. Full interactive reference: api.vidapp.com/docs.

Getting access

API keys are issued per app - contact your VidApp account manager to get yours. Every request needs the key in the x-api-key header. To verify a key, call GET https://api.vidapp.com/health - a 200 response means the key is valid.

Customers

VidApp holds the customer record for your app's users: name, email, and password. Each customer also has a Stripe customer ID. Via the API you can:

  • Create a customer - POST /users/. The user can sign in to your app immediately, and the response includes their Stripe customer ID.
  • Update a customer - PATCH /users/{user_id}. Changing an email or password requires the current password.

Web subscriptions themselves live in Stripe - VidApp reads subscription state directly from Stripe, so there is nothing to sync for billing.

Product access

A user's access is worked out on VidApp's side from three sources: their active Stripe subscription, their in-app (App Store / Google Play) subscription, and any access granted manually in VidApp. Manual access can be granted in the Builder's Members page or via the API with PUT /user_products/.

Webhooks

Register an HTTPS endpoint per event type with PUT /webhooks/subscribe and VidApp will POST the event to it as it happens. Available events:

  • UserSignUp - a user signed up
  • UserUpdate - a user's details changed
  • SubscriptionCreated - a subscription started
  • SubscriptionChanged - a subscription moved to a different plan
  • SubscriptionCancelled - a subscription was cancelled
  • PendingCancellation - a subscription was set to cancel at period end
  • TrialConverted - a trial converted to a paid subscription

Requirements for your endpoint:

  • It must be an https:// URL.
  • It must respond with HTTP 200. Any other status (including 201 or 204) is treated as a failure and the event is retried.

To stop receiving an event, call DELETE /webhooks/unsubscribe with the event type. For each event's payload, when it fires, and delivery/retry behavior, see VidApp API webhooks reference.

Full reference

Endpoint details, request and response schemas, and examples are at api.vidapp.com/docs. If you need an API key or help with an integration, contact VidApp support.

Related articles