webhook_uri parameter. Pipedream will send a POST request to this URL when the user completes the connection flow, or if an error occurs at any point. See the API docs for details.
Webhook events
CONNECTION_SUCCESS- Sent when the user successfully connects their accountCONNECTION_ERROR- Sent when an error occurs during the connection flow
Webhook payload
Successful connection
Please note that user credentials are not sent in the webhook request. To retrieve credentials, use the Connect API to fetch the account using theaccount.id provided in the webhook payload.
{
"event": "CONNECTION_SUCCESS",
"connect_token": "abc123",
"environment": "production",
"connect_session_id": 123,
"account": {
"id": "apn_abc123",
"name": "My Slack workspace",
"external_id": "U123456",
"healthy": true,
"dead": false,
"app": {
"id": "app_abc123",
"name_slug": "slack",
"name": "Slack",
"auth_type": "oauth",
"description": "Slack is a channel-based messaging platform",
"img_src": "https://assets.pipedream.net/icons/slack.svg",
"custom_fields_json": [],
"categories": "Communication",
},
"created_at": "2021年09月01日T00:00:00Z",
"updated_at": "2021年09月01日T00:00:00Z",
}
}
Error
{
"event": "CONNECTION_ERROR",
"connect_token": "abc123",
"environment": "production",
"connect_session_id": 123,
"error": "You've hit your limit on the number of external users you can connect."
}