Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Webhooks

Retrieve Webhook

If you have the webhookId for a specific webhook, you can get the details of that webhook.See the description of this endpoint for more details on how the system stores webhooks. For more information on how webhooks work in Plug, see this page.

This endpoint supports Sandbox Mode.

get/webhooks/{webhookId}

Path parameters

webhookIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

createdAtstring date-time nullable required

A timestamp indicating when the entity was created.

eventType'STATUS_CHANGE' | 'MFA_CHALLENGE_METHOD' | 'MFA_CHALLENGE_CODE' | 'EXISTING_DATA_UPDATED' | 'NEW_DATA_AVAILABLE' | 'REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS' | 'REAL_TIME_CREDENTIAL_VALIDATION_FAILURE' | 'BUSINESS_UNIT_ASSIGNMENT' nullable required

The type of webhook. This field indicates the reason the webhook was emitted.

idstring required

A unique identifier for the entity.

lastAttemptedSendAtstring date-time nullable required

The timestamp indicating when we last attempted to send this webhook to you.

lastSendHttpStatusinteger nullable required

The HTTP status code received for the most recent attempt to send this webhook.

messagestring required

The body payload of the webhook as a JSON string.

nextScheduledSendAtstring date-time nullable required

The scheduled time for the next webhook to be sent.

numberOfAttemptsinteger required

The number of attempts we have made to send this webhook.

resource'STATEMENT' | 'ACCOUNT' | 'CREDENTIAL' | 'DELETION' | 'FILE' | 'MFA_METHOD_PROMPT' | 'MFA_CODE_PROMPT' | 'DOWNLOAD' | 'ROOT_BUSINESS_UNIT_ACCOUNT' nullable required

The resource type of the entity that the webhook references. This field determines the structure of the payload contained in the data field of the webhook body.

status'WAITING_RESEND' | 'FAILURE' | 'SUCCESS' required

Status of the resource.

webhookUrlstring required

The URL in Live mode used for you to receive webhook notifications or callbacks.