> For the complete documentation index, see [llms.txt](https://docs.pushpushgo.company/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pushpushgo.company/web-push/sdk/legacy-sdk-deprecated.md).
# Legacy SDK (deprecated)
PushPushGo SDK is a software development kit that allows you to integrate web push without our integration script, but with customization possibilities.
### Setup
1. Place PushPushGo service worker with your project Id in sw\.js file on the website server.
{% code title="sw\.js" %}
```javascript
importScripts('https://cdn.pushpushgo.com/$projectId/worker.js');
```
{% endcode %}
2. Copy SDK script and place it in the website source code. Integration script has to be placed in the section of website's DOM structure.
{% code title="index.html" %}
```javascript
```
{% endcode %}
3. Initialize SDK client.
```javascript
const config = {
projectId: $projectId,
vapidPublicKey: $vapidPublicKey,
isHTTPS: $isHTTPS,
endpoint: 'https://api.pushpushgo.com',
swPath?: $serviceWorkerPath,
websitePushId?: $websitePushId,
};
const client = new ppg.sdk.Client(config);
```
| parameter | type | description |
| ---------------- | --------- | --------------------------------------------------------------------- |
| `projectId` | `string` | required |
| `vapidPublicKey` | `string` | required |
| `isHTTPS` | `boolean` | required, whetver your website address has `http` or `https` protocol |
| `endpoint` | `string` | required, value: `https://api.pushpushgo.com` |
| `websitePushId` | `string` | optional, for Safari < 16 integration |
| `swPath` | `string` | optional, path to `sw.js` file when other than root |
### Push notifications
#### `isPushSupport(): Promise`
Check if the browser supports web push notifications.
#### `checkPermission(): Promise`
Check for native permission.
### Subscription
#### `register(options?: ISubscribeOptions): Promise`
Register new subscriber - show popup dialog or native permission window
`returns` subscriberId
| parameter | type | description |
| --------- | ---------------------- | ----------- |
| `fields` | `{ customId?: string}` | optional |
| `tags` | `string[]` | optional |
#### `isSubscribed(): Promise`
Check if subscriber is registered
#### `getId(): Promise`
`returns` subscriberId
#### `unsubscribe(): Promise`
Unsubscribe existing subscriber at database
### Custom Id
#### `setCustomId(customId: string | number): Promise`
Sets customId in cloned store
#### `getCustomId(): Promise`
`returns` subscriber's customId
### Labels
#### `appendTags(tags: string[]): Promise`
Append tags to store. For tag with labels support use `labelName:tagName` syntax.
| parameter | type | description |
| --------- | ---------- | ----------- |
| `tags` | `string[]` | |
#### `getTags(): Promise`
`returns` current subscriber's tags
#### `removeTags(tags: string[]): Promise`
Remove tag(s) by label from store For labels support please use `'labelName:tagName'` syntax
#### `getTagsToRemove(): Promise`
`returns` subscriber's tags to remove
### Session data
#### `setSelector(selectorName: string, value: string | number | null | boolean): Promise`
Set selector value - field must be declared in application first
#### `clearState(): void`
Clear state, reset values
### Beacons
#### `send(immediately?: boolean): Promise`
Set beacon to send on event before unload
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.pushpushgo.company/web-push/sdk/legacy-sdk-deprecated.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.