Property | Type | Description |
---|
Method | Description | |
---|---|---|
Create ( |
Subscribes your webhook listener to events. A successful call returns a [`webhook`](/docs/api/webhooks/#definition-webhook) object, which includes the webhook ID for later use.
|
|
Create ( |
Creates the Webhook for the application associated with the access token.
|
|
Delete ( |
Deletes a webhook, by ID.
|
|
Delete ( |
Deletes a webhook, by ID.
|
|
Get ( |
Shows details for a webhook, by ID.
|
|
GetAll ( |
Lists all webhooks for an app.
|
|
Update ( |
Replaces webhook fields with new values. Pass a `json_patch` object with `replace` operation and `path`, which is `/url` for a URL or `/event_types` for events. The `value` is either the URL or a list of events.
|
|
Update ( |
Updates the Webhook identified by webhook_id for the application associated with access token.
|
public Create ( |
||
apiContext | APIContext used for the API call. | |
return |
public static Create ( |
||
apiContext | APIContext used for the API call. | |
webhook | ||
return |
public Delete ( |
||
apiContext | APIContext used for the API call. | |
return | void |
public static Delete ( |
||
apiContext | APIContext used for the API call. | |
webhookId | string | The ID of the webhook to delete. |
return | void |
public static Get ( |
||
apiContext | APIContext used for the API call. | |
webhookId | string | The ID of the webhook for which to show details. |
return |
public static GetAll ( |
||
apiContext | APIContext used for the API call. | |
anchorType | string | Filters the response by an entity type, `anchor_id`. Value is `APPLICATION` or `ACCOUNT`. Default is `APPLICATION`. |
return |
public Update ( |
||
apiContext | APIContext used for the API call. | |
patchRequest | PatchRequest | PatchRequest |
return |
public static Update ( |
||
apiContext | APIContext used for the API call. | |
webhookId | string | ID of the webhook to be updated. |
patchRequest | PatchRequest | PatchRequest |
return |