PipedreamHQ / PipedreamHQ/pipedream

[APP] Everflow - authenticated API requests

Open
#21,494 0 comments 0 reactions 0 assignees View on GitHub
app enhancement triaged
Dominant language
JavaScript
Stars
11.7k
Forks
5.8k
Avg merge
3d 10h
Merged PRs (30d)
102

Description

**Name of app / service**

Everflow

**Developer documentation**

- Network API and authentication:
https://developers.everflow.io/api-reference/network-overview
- Create Advertiser:
https://developers.everflow.io/api-reference/post-networksadvertisers
- Copy Offer:
https://developers.everflow.io/api-reference/get-networksofferscopy
- Retrieve Offer:
https://developers.everflow.io/api-reference/get-networksoffer
- Update Offer:
https://developers.everflow.io/api-reference/put-networksoffer
- Upload Temporary File:
https://developers.everflow.io/api-reference/post-networksupload
- Create Creative:
https://developers.everflow.io/api-reference/post-networkscreatives

Everflow’s Network API uses an API key supplied through the `X-Eflow-Api-Key` header.

**Is lack of support preventing you from moving forward, or do you have a workaround?**

Yes. This is blocking a reusable production capability in Get BOB for businesses operating affiliate programs through Everflow.

The initial use case is an active customer workflow that provisions advertisers and offers, then transfers creative files from Dropbox into Everflow and attaches them to the appropriate offer.

Direct HTTP requests are technically possible, but each workflow must then implement its own credential handling, payload construction, file encoding, response parsing, and Everflow-specific error handling.

Offer updates are particularly sensitive because Everflow documents that omitted optional fields may revert to defaults. The workflow must retrieve the existing offer, merge the intended changes, and submit a complete update.

End users would not configure these API requests directly. Get BOB would generate and execute them inside a validated workflow with safeguards, duplicate checks, and approval steps.

A native Everflow connection is needed to provide secure, reusable authentication without exposing API keys or recreating credential handling in every workflow.

**Requested initial implementation**

The minimum usable release is:

1. **Everflow authentication**
2. **Make an API Request**

The generic request action should support:

- `GET`, `POST`, `PUT`, and `PATCH`;
- a dynamic endpoint path relative to the Everflow Network API base URL;
- query parameters and JSON request bodies;
- automatic API-key authentication;
- structured response and error data.

This would allow the workflow to:

- create an advertiser;
- copy an approved offer template;
- retrieve and safely update the copied offer;
- upload a temporary creative file;
- create the creative;
- retrieve the resulting resources for verification.

The existing Dropbox integration already supplies the source files. Payload construction, validation, safe-update logic, duplicate checks, and approval rules would be handled by Get BOB.

Typed actions for individual Everflow resources would be useful later but are not required initially.

### File-upload fallback

Everflow’s temporary-file endpoint requires base64-encoded file content.

Our observed production-equivalent files have reached approximately **58.5 MB**, producing roughly **78 MB** of base64 content before JSON overhead.

If **Make an API Request** cannot reliably handle payloads of this size, the only additional action required initially would be **Upload Temporary File**.

It should accept a file from a previous Pipedream step, perform the reading and base64 encoding internally, upload it to Everflow, and return the temporary resource URL.

### Demand and implementation support

The immediate workflow is expected to process dozens of creative-delivery jobs per month, alongside recurring advertiser and offer-provisioning requests.

We can provide immediately through a secure channel:

- a dedicated Everflow test account and valid API key;
- synthetic advertiser, offer, and creative data;
- sample images and ZIP archives;
- request and response examples;
- successful and unsuccessful test cases;
- prompt implementation feedback.

No customer credentials, production data, or customer participation are required.

Broader typed actions and triggers are not required for the initial release.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing Dropbox integration and the implementation of the requested “Make an API Request” action, then review Everflow’s Network API authentication and endpoint documentation. Done means authenticated GET, POST, PUT, and PATCH requests support paths, query parameters, JSON bodies, and structured responses; assess the separate upload action if the stated file size is not reliable.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.